net6.0/Trisoft.ISHRemote.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Trisoft.ISHRemote</name> </assembly> <members> <member name="T:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation"> <summary> <para type="synopsis">The Add-IshAnnotation cmdlet adds a new annotation to the specified content object</para> <para type="description">The Add-IshAnnotation cmdlet adds a new annotation to the specified content object</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -Name "FISHREVISIONID" -Level Annotation -Value "GUID-MYREVISIONID" | Set-IshMetadataField -Name "FISHPUBLOGICALID" -Level Annotation -Value "GUID-MYPUBLICATIONLOGICALID" | Set-IshMetadataField -Name "FISHPUBVERSION" -Level Annotation -Value "1" | Set-IshMetadataField -Name "FISHPUBLANGUAGE" -Level Annotation -Value "en" | Set-IshMetadataField -Name "FISHANNOTATIONSTATUS" -Level Annotation -Value "VANNOTATIONSTATUSUNSHARED" -ValueType Element | Set-IshMetadataField -Name "FISHANNOTATIONADDRESS" -Level Annotation -Value "My annotation address" | Set-IshMetadataField -Name "FISHANNOTATIONTEXT" -Level Annotation -Value "My annotation text" | Set-IshMetadataField -Name "FISHANNOTATIONCATEGORY" -Level Annotation -Value "Comment" | Set-IshMetadataField -Name "FISHANNOTATIONTYPE" -Level Annotation -Value "General" $ishAnnotation = Add-IshAnnotation -IshSession $ishsession -Metadata $metadata </code> <para>Add annotation providing Metadata object. Full manual mode - validation of the incoming metadata is on the API side</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation -Value "My proposed change text" $ishAnnotation = Add-IshAnnotation -IshSession $ishsession ` -PubLogicalId "GUID-MYPUBLICATIONLOGICALID" ` -PubVersion "1" ` -PubLng "en" ` -LogicalId "MYCONTENTOBJECTLOGICALID" ` -Version "1" ` -Lng "en" ` -Type "General" ` -Text "My annotation text" ` -Status "Unshared" ` -Category "Comment" ` -Address "My annotation address" ` -Metadata $metadata </code> <para>Add annotation providing required parameters and Metadata object. Cmdlet will use the latest RevisionId for the provided content object and parameter values take precedence over metadata field values</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadataFilter = Set-IshMetadataFilterField -Name "VERSION" -Level Version -ValueType Value -Value "1" | Set-IshMetadataFilterField -Name "DOC-LANGUAGE" -Level Lng -ValueType Value -Value "en" $ishObject = Get-IshDocumentObj -IshSession $ishsession -LogicalId "MYCONTENTOBJECTLOGICALID" -MetadataFilter $metadataFilter $metadata = Set-IshMetadataField -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation -Value "My proposed change text" $ishAnnotation = Add-IshAnnotation -IshSession $ishsession ` -PubLogicalId "GUID-MYPUBLICATIONLOGICALID" ` -PubVersion "1" ` -PubLng "en" ` -IshObject $ishObject ` -Type $annotationType ` -Text "My annotation text" ` -Status "Unshared" ` -Category "Comment" ` -Address "My annotation address" ` -Metadata $metadata </code> <para>Add annotation providing IshObject of type IshDocumentObj. Cmdlet will use the latest RevisionId for the provided content object and parameter values take precedence over metadata field values</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishAnnotation = Add-IshAnnotation -IshSession $ishsession ` -PubLogicalId "GUID-MYPUBLICATIONLOGICALID" ` -PubVersion "1" ` -PubLng "en" ` -LogicalId "MYCONTENTOBJECTLOGICALID" ` -Version "1" ` -Lng "en" ` -Type "General" ` -Text "My annotation text" ` -Status "Unshared" ` -Category "Comment" ` -Address "My annotation address" ` $ishAnnotation = $ishAnnotation | Set-IshMetadataField -Name "FISHANNOTATIONTEXT" -Level Annotation -Value "My annotation text updated" $ishAnnotationAdded = $ishAnnotation | Add-IshAnnotation -IshSession $ishsession </code> <para>Add annotation providing IshAnnotation object.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.PubLogicalId"> <summary> <para type="description">Publication LogicalId</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.PubVersion"> <summary> <para type="description">Publication version</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.PubLng"> <summary> <para type="description">Publication language</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.LogicalId"> <summary> <para type="description">LogicalId of the content object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Version"> <summary> <para type="description">Version of the content object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Lng"> <summary> <para type="description">Language of the content object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Type"> <summary> <para type="description">Type of the annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Text"> <summary> <para type="description">Text of the annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Status"> <summary> <para type="description">Status of the annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Address"> <summary> <para type="description">Address of the annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Category"> <summary> <para type="description">Category of the annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.Metadata"> <summary> <para type="description">The metadata of the Annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.IshObject"> <summary> <para type="description">The IShObject - content object containing full LogicalId/Version/Language combination</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.IshAnnotation"> <summary> <para type="description">The IshAnnotation array that needs to be created. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.ProcessRecord"> <summary> Process the Add-IshAnnotation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="P:Trisoft.ISHRemote.Cmdlets.Annotation.AddIshAnnotation.IshAnnotation"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Annotation.FindIshAnnotation"> <summary> <para type="synopsis">The Find-IshAnnotation cmdlet finds annotations using MetadataFilter</para> <para type="description">The Find-IshAnnotation cmdlet finds annotations using MetadataFilter</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential username $ishAnnotations = Find-IshAnnotation </code> <para>Find all annotations, beware that large results could be requested here</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHANNOTATIONREPLIES" -Level Annotation $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name FISHANNOTATIONTEXT -Level Annotation -FilterOperator Like -Value "Test%" $ishAnnotations = Find-IshAnnotation -IshSession $ishsession ` -RequestedMetadata $requestedMetadata ` -MetadataFilter $metadataFilter </code> <para>Find annotations providing RequestedMetadata and MetadataFilter</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.FindIshAnnotation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.FindIshAnnotation.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of annotations returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.FindIshAnnotation.RequestedMetadata"> <summary> <para type="description">The requested metadata fields to retrieve</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.FindIshAnnotation.ProcessRecord"> <summary> Process the Find-IshAnnotation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="T:Trisoft.ISHRemote.Objects.Public.IshAnnotation"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation"> <summary> <para type="synopsis">The Get-IshAnnotation cmdlet gets annotations for the specified AnnotationIds for IshAnnotation object or for the specified IshObject</para> <para type="description">The Get-IshAnnotation cmdlet gets annotations for the specified AnnotationIds for IshAnnotation object or for the specified IshObject</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHANNOTATIONREPLIES" -Level Annotation $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name FISHANNOTATIONTEXT -Level Annotation -FilterOperator Like -Value "Test%" $ishAnnotations = Get-IshAnnotation -IshSession $ishsession ` -AnnotationId @("GUID-ANNOTATION-ID1", "GUID-ANNOTATION-ID2") ` -RequestedMetadata $requestedMetadata ` -MetadataFilter $metadataFilter </code> <para>Get annotations providing AnnotationId array, RequestedMetadata and MetadataFilter</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation $ishAnnotations = @($ishObjectPublication1, $ishObjectPublication2) | Get-IshAnnotation -IshSession $ishsession -RequestedMetadata $requestedMetadata </code> <para>Get annotations by providing IshPublication objects through the pipeline</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation $ishAnnotations = @($ishDocumentObj1, $ishDocumentObj2) | Get-IshAnnotation -IshSession $ishsession -RequestedMetadata $requestedMetadata </code> <para>Get annotations by providing DocumentObj (like ISHModule, ISHMasterDoc,...) objects through the pipeline</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential username $requestedMetadata = Set-IshRequestedMetadataField -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation $ishAnnotations = Get-Ishfolder -FolderPath "General\Myfolder" -Recurse | Get-IshFolderContent | Get-IshAnnotation -RequestedMetadata $requestedMetadata </code> <para>Get annotations by piping Get-IshFolderContent output</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.AnnotationId"> <summary> <para type="description">Annotation Ids</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of annotations returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.IshObject"> <summary> <para type="description">IshPublication or IshDocumentObj objects containing full LogicalId/Version/Language combination</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.IshAnnotation"> <summary> <para type="description">The IshAnnotation array that needs to be retrieved. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.EndProcessing"> <summary> Process the Get-IshAnnotation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="P:Trisoft.ISHRemote.Cmdlets.Annotation.GetIshAnnotation.IshAnnotation"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation"> <summary> <para type="synopsis">The Remove-IshAnnotation cmdlet removes annotation and all of its replies</para> <para type="description">The Remove-IshAnnotation cmdlet removes annotation and all of its replies</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Remove-IshAnnotation -IshSession $ishsession -AnnotationId "MYANNOTATIONREF" </code> <para>Remove annotation providing AnnotationId. For the $ishAnnotation variable holding IshAnnotation object, AnnotationId is stored as property $ishAnnotation.IshRef</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential username $ishAnnotations | Remove-IshAnnotation </code> <para>Remove annotations passing IshAnnotation array(or a single object) through the pipeline</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation.AnnotationId"> <summary> <para type="description">AnnotationId</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation.IshAnnotation"> <summary> <para type="description">The IshAnnotation array that needs to be deleted. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.RemoveIshAnnotation.EndProcessing"> <summary> Process the Remove-IshAnnotation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation"> <summary> <para type="synopsis">The Set-IshAnnotation cmdlet updates annotations that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshAnnotation cmdlet updates annotations that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadataUpdate = Set-IshMetadataField -Name "FISHANNOTATIONSTATUS" -Level Annotation -Value "Shared" -ValueType Value $requiredCurrentMetadata = Set-IshRequiredCurrentMetadataField -Name "FISHANNOTATIONSTATUS" -Level Annotation -Value "Unshared" -ValueType Value $ishAnnotation = Set-IshAnnotation -AnnotationId "MYANNOTATIONID" -Metadata $metadataUpdate -RequiredCurrentMetadata $requiredCurrentMetadata </code> <para>Update annotation providing AnnotationId, Metadata and RequiredCurrentMetadata</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -Name "FISHANNOTPROPOSEDCHNGTXT" -Level Annotation -Value "My proposed change text" $ishAnnotation = Add-IshAnnotation -PubLogicalId "GUID-MYPUBLICATIONLOGICALID" ` -PubVersion "1" ` -PubLng "en" ` -LogicalId "MYCONTENTOBJECTLOGICALID" ` -Version "1" ` -Lng "en" ` -Type "General" ` -Text "My annotation text" ` -Status "Unshared" ` -Category "Comment" ` -Address "My annotation address" $metadataUpdate = Set-IshMetadataField -Name "FISHANNOTATIONSTATUS" -Level Annotation -Value "Shared" -ValueType Value $requiredCurrentMetadata = Set-IshRequiredCurrentMetadataField -Name "FISHANNOTATIONSTATUS" -Level Annotation -Value "Unshared" -ValueType Value $ishAnnotationUpdated = $ishAnnotation | Set-IshAnnotation -Metadata $metadataUpdate -RequiredCurrentMetadata $requiredCurrentMetadata </code> <para>Update annotation providing ISHAnnotation object via pipeline, Metadata and RequiredCurrentMetadata</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.AnnotationId"> <summary> <para type="description">Id of the Annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.Metadata"> <summary> <para type="description">The metadata of the Annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the Annotation</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.IshAnnotation"> <summary> <para type="description">The IshAnnotation array that needs to be set. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.EndProcessing"> <summary> Process the Set-IshAnnotation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="P:Trisoft.ISHRemote.Cmdlets.Annotation.SetIshAnnotation.IshAnnotation"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Application.GetIshVersion"> <summary> <para type="synopsis">The Get-Version cmdlet gets the version information of the InfoShare application.</para> <para type="description">The Get-Version cmdlet gets the version information of the InfoShare application.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshVersion -IshSession $ishSession </code> <para>Get version example with explicit IshSession</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshVersion </code> <para>Get version example with implicit IshSession</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Application.GetIshVersion.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask"> <summary> <para type="synopsis">The Add-IshBackgroundTask cmdlet adds fire-and-forget asynchronous processing events to the CMS generic queuing system.</para> <para type="description">Add-IshBackgroundTask ParameterGroup variation uses BackgroundTask25.CreateBackgroundTask(WithStartAfter) that allows you to submit generic messages. Note that this requires a generic BackgroundTask service message handler.</para> <para type="description">Add-IshBackgroundTask IshObjectsGroup requires content object(s) which are transformed as message inputdata and passed to the Background Task.</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $ishBackgroundTask = Get-IshFolderContent -FolderPath "General\MyFolder\Topics" -VersionFilter Latest -LanguagesFilter en | Add-IshBackgroundTask -EventType "SMARTTAG" </code> <para>Add BackgroundTask with event type "SMARTTAG" for the objects located under the "General\MyFolder\Topics" path. Trigger a legacy correction event of SMARTTAG across many folders. Note that the default value for the -InputDataTemplate is IshObjectsWithLngRef.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $ishBackgroundTask = Get-IshFolder -FolderPath "General\Myfolder" -FolderTypeFilter @("ISHModule", "ISHMasterDoc", "ISHLibrary") -Recurse | ForEach-Object -Process { Get-IshFolderContent -IshFolder $_ -VersionFilter Latest -LanguagesFilter en | Add-IshBackgroundTask -EventType "SMARTTAG" } </code> <para>Add BackgroundTask with event type "SMARTTAG" for the latest-version en(glish) content objects of type topic, map and topic library; located under the "General\MyFolder" path. Trigger a legacy correction event of SMARTTAG per folder. Note that the default value for the -InputDataTemplate is IshObjectsWithLngRef. Note that Get-IshFolder gives you a progress bar for follow-up. Note that it is possible to configure the BackgroundTask-handler with a variation of the SMARTTAG event to do more-or-less fields for automatic concept suggestions.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $ishBackgroundTask = Get-IshFolder -BaseFolder Data -FolderTypeFilter @("ISHIllustration") -Recurse | ForEach-Object -Process { Get-IshFolderContent -VersionFilter Latest | Add-IshBackgroundTask -EventType "SYNCHRONIZEMETRICS" -InputDataTemplate IshObjectsWithIshRef } </code> <para>Add BackgroundTask with event type "SYNCHRONIZEMETRICS" for the latest-version content objects of type image; located under the "General" path. Trigger an event of synchronizing images per folder to the Metrics subsystem. Note that Get-IshFolder gives you a progress bar for follow-up.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $ishBackgroundTask = Get-IshFolder -FolderPath "General\MyFolder\Images" -Recurse | ForEach-Object -Process { Get-IshFolderContent -IshFolder $_ -VersionFilter Latest -LanguagesFilter en | Add-IshBackgroundTask -EventType "FOLDEREXPORT" -InputDataTemplate EventDataWithIshLngRefs } </code> <para>Add BackgroundTask with event type `FOLDEREXPORT` for the objects located under the `General\MyFolder\Images` path. Note that the BackgroundTask handler behind all `...EXPORT` events like `SEARCHEXPORT` or `INBOXEXPORT` on Tridion Docs 15.1 and earlier is identical. One BackgroundTask message will appear per folder containing a list of all latest version English (`en`) content objects in the `InputData` of the message. Note that without the `ForEach-Object` construction all recursively found content objects would all be passed in one BackgroundTask message.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $rawData = "<data><export-document-type>ISHPublication</export-document-type><export-document-level>lng</export-document-level><export-ishlngref>549482</export-ishlngref><creationdate>20210303070257182</creationdate></data>" $ishBackgroundTask = Add-IshBackgroundTask -EventType "PUBLISH" -EventDescription "Custom publish event description" -RawInputData $rawData </code> <para>Add background task with the event type "PUBLISH" and provided event description and publish input raw data. Note: example code only, for publish operations usage of Publish-IshPublicationOutput cmdlet is preferred.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $rawData = "<data><export-document-type>ISHPublication</export-document-type><export-document-level>lng</export-document-level><export-ishlngref>549482</export-ishlngref><creationdate>20210303070257182</creationdate></data>" $date = (Get-Date).AddDays(1) $ishBackgroundTask = Add-IshBackgroundTask -EventType "PUBLISH" -EventDescription "Custom publish event description" -RawInputData $rawData -StartAfter $date </code> <para>Add background task with the event type "PUBLISH" and provided event description and publish input raw data. Provided StartAfter parameter with tomorrow's date indicates that background task should not be executed before this date. Note: example code only, for publish operations usage of Publish-IshPublicationOutput cmdlet is preferred.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.EventType"> <summary> <para type="description">Type of the event (e.g. SMARTTAG). Needs a match CMS BackgroundTask service handler entry.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.RawInputData"> <summary> <para type="description">The input data for the background task.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.EventDescription"> <summary> <para type="description">Description of the event</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.StartAfter"> <summary> <para type="description">Date time indicating that the background task should not be picked up and executed before it.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.IshObject"> <summary> <para type="description">The <see cref="T:Trisoft.ISHRemote.Objects.IshObjects"/>s that will be used for background task creation.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.InputDataTemplate"> <summary> <para type="description">The InputDataTemplate (e.g. IshObjectWithLngRef) indicates whether a list of ishObjects or one ishObject is submitted as input data to the background task.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.HashId"> <summary> <para type="description">The hash id of the background task.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.BackgroundTask.AddIshBackgroundTask.EndProcessing"> <summary> Process the Add-IshBackgroundTask cmdlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="T:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask"/> to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask"> <summary> <para type="synopsis">Gets BackgroundTask entries with filtering options.</para> <para type="description">Uses BackgroundTask25 API to retrieve backgroundtasks showing their status, lease, etc from the virtual queue.</para> <para type="description">This table oriented API maps straight through to database column names regarding ishfield usage.</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" Get-IshBackgroundTask </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Returns the full denormalized task/history entries limited to only Basic fields, for All users and the last 24 hours.</para> </example> <example> <code> $allMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name CREATIONDATE | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name CURRENTATTEMPT | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name EVENTTYPE | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name EXECUTEAFTERDATE | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name HASHID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name INPUTDATAID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name LEASEDBY | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name LEASEDON | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name MODIFICATIONDATE | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name OUTPUTDATAID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name PROGRESSID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name STATUS -ValueType Value | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name STATUS -ValueType Element | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name TASKID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name TRACKINGID | Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name USERID -ValueType All | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name ENDDATE | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name ERROR | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name ERRORNUMBER | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name EXITCODE | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name HISTORYID | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name HOSTNAME | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name OUTPUT | Set-IshRequestedMetadataField -IshSession $ishSession -Level History -Name STARTDATE Get-IshBackgroundTask -IshSession $ishSession -RequestedMetadata $allMetadata </code> <para>Returns the full denormalized task/history entries limited to All users and the last 24 hours.</para> </example> <example> <code> Get-IshBackgroundTask -IshSession $ishSession -ModifiedSince ((Get-Date).AddSeconds(-10)) -UserFilter Current </code> <para>Returns the full denormalized task/history entries limited to only Basic fields, the current user and limited to 10 seconds ago of activity.</para> </example> <example> <code> $filterMetadata = Set-IshMetadataFilterField -IshSession $ishSession -Level Task -Name EVENTTYPE -FilterOperator In -Value "CREATETRANSLATIONS, CREATETRANSLATIONFROMLIST" | Set-IshMetadataFilterField -IshSession $ishSession -Level Task -Name TASKID -Value $taskId Get-IshBackgroundTask -IshSession $ishSession -MetadataFilter $filterMetadata </code> <para>Returns the full denormalized task/history entries limited to only Basic fields, for All users and the last 24 hours.</para> </example> <example> <code> $metadata = Set-IshRequestedMetadataField -IshSession $ishSession -Level Task -Name STATUS Get-IshBackgroundTask -IshSession $ishSession -RequestedMetadata $metadata | Group-Object -Property status </code> <para>Returns the group-by count by status, for All users and the last 24 hours.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.UserFilter"> <summary> <para type="description">Enumeration indicating if only events of the current user or all events must be retrieved</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.ModifiedSince"> <summary> <para type="description">A date limiting the events that will be retrieved based on the last modification date of the events</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.MetadataFilter"> <summary> <para type="description">Filter on metadata to limit the objects on which metadata has to be returned</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.RequestedMetadata"> <summary> <para type="description">XML structure indicating which metadata has to be retrieved.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.IshBackgroundTask"> <summary> <para type="description">The <see cref="P:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.IshBackgroundTask"/>s that need to be handled.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.BackgroundTask.GetIshBackgroundTask.EndProcessing"> <summary> Process the cmdlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="T:Trisoft.ISHRemote.Objects.Public.IshEvent"/> to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.AddIshBaseline"> <summary> <para type="synopsis">The Add-IshBaseline cmdlet adds the new baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshBaseline cmdlet adds the new baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" Add-IshBaseline -IshSession $ishSession -Name "My first baseline" </code> <para>Create a baseline ishobject, that holds no baseline entries</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.AddIshBaseline.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.AddIshBaseline.IshObject"> <summary> <para type="description">Array with the baselines to create. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.AddIshBaseline.Name"> <summary> <para type="description">The name of the new baseline.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.AddIshBaseline.UserGroup"> <summary> API function takes user group parameter, in practice it is not used, so forcing empty UserGroup </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.FindIshBaseline"> <summary> <para type="synopsis">The Find-IshBaseline cmdlet finds baselines using MetadataFilter that are provided.</para> <para type="description">The Find-IshBaseline cmdlet finds baselines using MetadataFilter that are provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" Find-IshBaseline -IshSession $ishSession -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "NAME") </code> <para>Retrieve all baselines</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" Find-IshBaseline -MetadataFilter (Set-IshMetadataFilterField -IshSession $ishSession -Name "FISHBASELINEACTIVE" -ValueType Element -Value "FALSE") </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve all active baselines with Basic metadata.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.FindIshBaseline.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.FindIshBaseline.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.FindIshBaseline.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline"> <summary> <para type="synopsis">The Get-IshBaseline cmdlet retrieves the metadat of baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshBaseline cmdlet retrieves the metadat of baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineIds = @("GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534","GUID-F1361489-66F3-4E27-A5D1-71C97025815A") Get-IshBaseline -Id $baselineIds -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHDOCUMENTRELEASE") </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve metadata from the identified baselines</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineIds = @("GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534","GUID-F1361489-66F3-4E27-A5D1-71C97025815A") Get-IshBaseline -IshSesssion $ishSession -Id $baselineIds -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHDOCUMENTRELEASE") </code> <para>Retrieve metadata from the identified baselines</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline.Id"> <summary> <para type="description">The baseline identifiers for which to retrieve the metadata</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaseline.IshObject"> <summary> <para type="description">Array with the baselines for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaselineItem"> <summary> <para type="synopsis">The Get-IshBaselineItem cmdlet retrieves the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshBaselineItem cmdlet retrieves the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineIds = @("GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534","GUID-F1361489-66F3-4E27-A5D1-71C97025815A") Get-IshBaselineItem -IshSession $ishSession -Id $baselineIds </code> <para>Returns the baseline entries for the identified baselines including the baseline identifier</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaselineItem.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaselineItem.Id"> <summary> <para type="description">The baseline identifiers for which to retrieve the baseline entries</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.GetIshBaselineItem.IshObject"> <summary> <para type="description">Array with the baselines for which to retrieve the baseline entries. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaseline"> <summary> <para type="synopsis">The Remove-IshBaseline cmdlet removes the baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshBaseline cmdlet removes the baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineId = "GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534" Remove-IshBaseline -IshSession $ishSession -Id $baselineId </code> <para>Retrieve metadata from the identified baseline</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaseline.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaseline.Id"> <summary> <para type="description">The identifier of the baseline to remove</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaseline.IshObject"> <summary> <para type="description">Array with the baselines to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaselineItem"> <summary> <para type="synopsis">The Remove-IshBaselineItem cmdlet removes the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshBaselineItem cmdlet removes the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineIds = @("GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534","GUID-F1361489-66F3-4E27-A5D1-71C97025815A") $ishObjects = Get-IshBaseline -IshSession $ishSession -Id $baselineIds Remove-IshBaselineItem -IshSession $ishSession -IshObject $ishObjects -LogicalId "GUID-12345678-ABCD-EFGH-IJKL-1234567890AB" </code> <para>Removes the LogicalId as baseline entry for the identified baselines</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaselineItem.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaselineItem.IshObject"> <summary> <para type="description">Array with the baselines for which to remove the baseline entries. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaselineItem.LogicalId"> <summary> <para type="description">The logical identifier of the content object</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Baseline.RemoveIshBaselineItem._baselineItemsToProcess"> <summary> <para type="description">Array with the baselines for which to retrieve the baseline entries. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaseline"> <summary> <para type="synopsis">The Set-IshBaseline cmdlet updates the baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshBaseline cmdlet updates the baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineId = "GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534" Set-IshBaseline -IshSession $ishSession -Id $baselineId -Metadata (Set-IshMetadataField -IshSession $ishSession -Name "FISHBASELINEACTIVE" -ValueType Element -Value "FALSE") </code> <para>Make the identified baseline inactive</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaseline.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaseline.Id"> <summary> <para type="description">The identifier of the user group to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaseline.Metadata"> <summary> <para type="description">The metadata to set for the user group</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaseline.IshObject"> <summary> <para type="description">User groups for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem"> <summary> <para type="synopsis">The Set-IshBaselineItem cmdlet creates or updates the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshBaselineItem cmdlet creates or updates the baseline entries of baselines that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $baselineIds = @("GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534","GUID-F1361489-66F3-4E27-A5D1-71C97025815A") $ishObjects = Get-IshBaseline -IshSession $ishSession -Id $baselineIds Set-IshBaselineItem -IshSession $ishSession -IshObject $ishObjects -LogicalId "GUID-12345678-ABCD-EFGH-IJKL-1234567890AB" -Version "999" </code> <para>Add or update the version of the baseline entry identified by the given LogicalId for the identified baselines</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $ishObjectSource = Get-IshBaseline -Id "GUID-17443161-9CAD-4A9A-A3D3-F2942EDB0534" $baselineItems = Get-IshBaselineItem -IshObject $ishObjectSource $ishObjectTarget = Add-IshBaseline -Name "New Baseline" $ishObjectTarget = Set-IshBaselineItem -IshObject ishObjectTarget -IshBaselineItem $baselineItems </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Reading the information from the source baseline and creating a new target baseline which we fill with the selected versions.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem.IshObject"> <summary> <para type="description">Array with the baselines for which to create or update the baseline entries. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem.LogicalId"> <summary> <para type="description">The logical identifier of the content object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem.Version"> <summary> <para type="description">The version of the content object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Baseline.SetIshBaselineItem.IshBaselineItem"> <summary> <para type="description">Array with the baseline entries which will be applied to the IshObject in a minimal number of API calls. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj"> <summary> <para type="synopsis">The Add-IshDocumentObj cmdlet adds the new document object(s) (which include illustrations) that are passed through the pipeline or determined via provided parameters This commandlet allows to create all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Add-IshPublicationOutput.</para> <para type="description">The Add-IshDocumentObj cmdlet adds the new document object(s) (which include illustrations) that are passed through the pipeline or determined via provided parameters This commandlet allows to create all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Add-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Write-Host "`r`nCreate a logical, version, language level" $ditaFileContent = @" <? xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.<? ish-replace-title?></title><shortdesc>Enter a short description of your topic here(optional).</shortdesc><body><p>This is the start of your topic.</p></body></topic> "@ $ishMetadataFields = Set-IshMetadataField -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" | Set-IshMetadataField -Name "FCHANGES" -Level "Version" -Value "Changes text field" | Set-IshMetadataField -Name "FSTATUS" -Level "Lng" -Value "Draft" | Set-IshMetadataField -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj ` -FolderId "0" ` #use valid FolderId -IshType "ISHModule" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FileContent $ditaFileContent $ishObject.ObjectRef| Format-Table </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Add Module without providing LogicalId, Version and using FileContent parameter</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "" -IshUserPassword "" Write-Host "`r`nCreate a logical, version, language level" $timestamp = get-date -Format "yyyyMMddHHmmss" $logicalId = "MYGUID-$timestamp" $ditaFilePath = "c:\temp\Task.dita" # Template which is used to create a language level $ishMetadataFields = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" ` | Set-IshMetadataField -IshSession $ishSession -Name "FCHANGES" -Level "Version" -Value "Changes text field" ` | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -Value "Draft" ` | Set-IshMetadataField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj -IshSession $ishSession ` -FolderId "0" ` #use valid FolderId -LogicalId $logicalId ` -IshType "ISHModule" ` -Version "1" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FilePath $ditaFilePath $ishObject.ObjectRef| Format-Table </code> <para>Add Module with providing LogicalId and Version</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "" -IshUserPassword "" Write-Host "`r`nCreate a logical, version, language level" $ditaFilePath = "c:\temp\Task.dita" # Template which is used to create a language level $ishMetadataFields = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" ` | Set-IshMetadataField -IshSession $ishSession -Name "FCHANGES" -Level "Version" -Value "Changes text field" ` | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -Value "Draft" ` | Set-IshMetadataField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj -IshSession $ishSession ` -FolderId "0" ` #use valid FolderId -IshType "ISHModule" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FilePath $ditaFilePath $ishObject.ObjectRef| Format-Table </code> <para>Add Module without providing LogicalId and Version</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.FolderId"> <summary> <para type="description">The FolderId of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshFolder"> <summary> <para type="description">The FolderId of the DocumentObj by IshFolder object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshType"> <summary> <para type="description">The <see cref="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshType"/>.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.LogicalId"> <summary> <para type="description">The LogicalId of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.Version"> <summary> <para type="description">The Version of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.Lng"> <summary> <para type="description">The Language of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.Resolution"> <summary> <para type="description">The Resolution of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.Metadata"> <summary> <para type="description">The metadata of the DocumentObj.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.Edt"> <summary> <para type="description">The unique identifier of the Electronic Document Type for the content (e.g. EDTPDF, EDTXML, EDTHTML,...) of the new object.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.FilePath"> <summary> <para type="description">The path to the file containing data for the DocumentObj</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.FileContent"> <summary> <para type="description">String with XML content of the DocumentObj</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshObject"> <summary> <para type="description">The <see cref="T:Trisoft.ISHRemote.Objects.IshObjects"/>s that need to be added.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._ishType"> <summary> Private fields to store the provide a default for non-mandatory parameters </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._logicalId"> <summary> Logical Id will be defaulted to typical GUID-XYZ in uppercase </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._version"> <summary> Version will be defaulted to NEW, meaning that a first or next version will be created for existing objects </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._edt"> <summary> EDT will be defaulted to EDTXML. Needs to match up with FileContent or FilePath content. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._folderId"> <summary> Holds the folder card id, specified by incoming parameter (long,IShObject) </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj._ishData"> <summary> Holds IshData object initialized either by EDT and FilePath or EDT and FileContent </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.ProcessRecord"> <summary> Process the Add-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.AddIshDocumentObj.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj"> <summary> <para type="synopsis">The Find-IshDocumentObj cmdlet finds document objects (which include illustrations) using MetadataFilter, TypeFilter and StatusFilter that are provided This commandlet allows to find all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Find-IshPublicationOutput.</para> <para type="description">The Find-IshDocumentObj cmdlet finds document objects (which include illustrations) using MetadataFilter, TypeFilter and StatusFilter that are provided This commandlet allows to find all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Find-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $yesterday = (Get-Date).AddDays(-1).ToString("dd/MM/yyyy HH:mm:ss") Find-IshDocumentObj -MetadataFilter(Set-IshMetadataFilterField -Level Lng -Name MODIFIED-ON -FilterOperator GreaterThan -Value $yesterday) </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Returns the documents that are touched since yesterday.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $dateInThePast = (Get-Date).AddDays(-2000).ToString("dd/MM/yyyy HH:mm:ss") $ishObjects = Find-IshDocumentObj -MetadataFilter(Set-IshMetadataFilterField -Level Lng -Name MODIFIED-ON -FilterOperator GreaterThan -Value $dateInThePast) ` -RequestedMetadata(Set-IshRequestedMetadataField -Level Lng -Name FISHLASTMODIFIEDON) $ishObjects | Select-Object -Property IshType, IshRef, version_version_value, doc-language, fresolution, fishlastmodifiedon, fishlastmodifiedby, fstatus, checked-out-by, ftitle_logical_value | Format-Table </code> <para>Timesliced retrieval based on the metadata MODIFIED-ON date. Note that adding a second MODIFIED-ON filter using LessThan is possible.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Find-IshDocumentObj -MetadataFilter (Set-IshMetadataFilterField -Name ED -Level Lng -FilterOperator Equal -Value GUID-92073CF5-ADFD-4FE4-9671-8196FCE5AE1D) </code> <para>Suppose you get a 'revisionId' back through some error message, then the above cmdlet is a way to return you the LogicalId (typically GUID), version and language back of the content object. The ED field holds the currently latest 'revisionId' while FISHREVISIONS holds the previously ones.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.IshTypeFilter"> <summary> <para type="description">The folder type filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.StatusFilter"> <summary> <para type="description">The status type filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj._statusFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.FindIshDocumentObj.ProcessRecord"> <summary> Process the Find-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj"> <summary> <para type="synopsis">Retrieves the metadata and optionally blob of document objects</para> <para type="description">Gets IshObject entries through logical id filtering or language card ids, optionally providing the blob.</para> <para type="description">Uses DocumentObj25 API to retrieve ishobjects.</para> <para type="description">The Get-IshDocumentObj cmdlet retrieves metadata of the document objects that are passed through the pipeline or determined via provided parameters. This commandlet allows to retrieve all types of objects(Illustrations, Maps, etc. ), except for publication(outputs). For publication(outputs) you need to use Get-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshDocumentObj -LogicalId ISHPUBLILLUSTRATIONMISSING </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Returns all versions/language of object identified through LogicalId Get-IshDocumentObj -LogicalId ISHPUBLILLUSTRATIONMISSING (typically also GUIDs).</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.LogicalId"> <summary> <para type="description">The logical identifiers of the document objects for which to retrieve the metadata</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.StatusFilter"> <summary> <para type="description">The status filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.IncludeData"> <summary> <para type="description">Switch patameter that specifies if the return objects should hold the blob (ishdata) sections, potentially conditionally published if IshFeature was passed</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.IshFeature"> <summary> <para type="description">The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.IshObject"> <summary> <para type="description">Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj._statusFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj._includeData"> <summary> Switch patameter that specifies if the return objects should hold the blob (ishdata) sections, potentially conditionally published if IshFeature was passed </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.ProcessRecord"> <summary> Process the Get-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObj.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData"> <summary> <para type="synopsis">The Get-IshDocumentObjData cmdlet retrieves the data/blob of the document objects that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder. This commandlet allows to retrieve all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputData.</para> <para type="description">The Get-IshDocumentObjData cmdlet retrieves the data/blob of the document objects that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder. This commandlet allows to retrieve all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputData.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -FilterOperator "Like" -Value "%topic%" | Set-IshMetadataFilterField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -FilterOperator "Equal" -Value "admin" | Set-IshMetadataFilterField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -FilterOperator "Equal" -Value "To be translated" $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FTITLE" -Level "logical" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "VERSION" -Level "version" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "DOC-LANGUAGE" -Level "lng" $fileList = Find-IshDocumentObj -IshSession $ishSession -MetadataFilter $ishMetadataFilterFields ` -IshTypeFilter "ISHModule" ` -RequestedMetadata $ishRequestedFields | Get-IshDocumentObjData $ishSession ` -FolderPath "c:\temp\export" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Download modules to a temp location</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData.IshObject"> <summary> <para type="description">Array with the objects for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData.FolderPath"> <summary> <para type="description">Folder on the Windows filesystem where to store the retrieved data files</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData.IshFeature"> <summary> <para type="description">The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjData.ProcessRecord"> <summary> Process the Get-IshDocumentObjData commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:System.IO.File"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjFolderLocation"> <summary> <para type="synopsis">The Get-IshDocumentObjFolderLocation cmdlet returns the repository location of a document object in a form of a separated string e.g. "General\Folder1\Folder2" This commandlet allows to retrieve the location of all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputFolderLocation.</para> <para type="description">The Get-IshDocumentObjFolderLocation cmdlet returns the repository location of a document object in a form of a separated string e.g. "General\Folder1\Folder2" This commandlet allows to retrieve the location of all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputFolderLocation.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderPath = Get-IshDocumentObjFolderLocation -LogicalId "GUID-8C8F01ED-9785-47DE-9A00-1F8AAFD94E7D" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve location of the DocumentObj</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjFolderLocation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjFolderLocation.LogicalId"> <summary> <para type="description">The LogicalId of the DocumentObj object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjFolderLocation.IshObject"> <summary> <para type="description">Object for which to retrieve the folder location. This object can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.GetIshDocumentObjFolderLocation.ProcessRecord"> <summary> Process the Get-IshDocumentObjFolderLocation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj"> <summary> <para type="synopsis">The Move-IshDocumentObj cmdlet moves document objects that are passed through the pipeline or determined via provided parameters from one repository folder to another folder. This commandlet allows to move all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Move-IshPublicationOutput.</para> <para type="description">The Move-IshDocumentObj cmdlet moves document objects that are passed through the pipeline or determined via provided parameters from one repository folder to another folder. This commandlet allows to move all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Move-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Move-IshDocumentObj -LogicalId ISHPUBLILLUSTRATIONMISSING -FromIshFolder (Get-IshFolder -BaseFolder System) -ToIshFolder (Get-IshDocumentObjFolderLocation -LogicalId ISHPUBLILLUSTRATIONMISSING) </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Moves DocumentObj (and PublicationOutput) to another folder.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.LogicalId"> <summary> <para type="description">The logical identifiers of the document objects to move</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.FromFolderId"> <summary> <para type="description">The folder identifier where the objects are currently located</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.FromIshFolder"> <summary> <para type="description">The IshFolder object where the objects are currently located</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.ToFolderId"> <summary> <para type="description">The folder identifier where to move the document objects to</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.ToIshFolder"> <summary> <para type="description">The IshFolder object where to move the document objects to</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.IshObject"> <summary> <para type="description">Array with the object to move. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj._fromFolderId"> <summary> Holds the folder card id, specified by incoming parameter (long,IShObject) </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj._toFolderId"> <summary> Holds the folder card id, specified by incoming parameter (long,IShObject) </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj._retrievedIshObjects"> <summary> Initially holds incoming IshObject entries from the pipeline to correct the incorrect array-objects from Trisoft.Automation </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.ProcessRecord"> <summary> Process the Move-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.EndProcessing"> <summary> EndProcess the Move-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.MoveIshDocumentObj.ReportErrors(System.String)"> <summary> Reports back the errors, warnings and messages retrieved by API </summary> <param name="errorReport">logger/logs Xml structure</param> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj"> <summary> <para type="synopsis">The Remove-IshDocumentObj cmdlet removes the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to remove all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Remove-IshPublicationOutput.</para> <para type="description">The Remove-IshDocumentObj cmdlet removes the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to remove all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Remove-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshFolder -FolderPath $folderCmdletRootPath -Recurse | Get-IshFolderContent | Remove-IshDocumentObj -Force </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Removes all content objects from the listed folder and its subfolders.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.LogicalId"> <summary> <para type="description">The logical identifier of the document object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.Version"> <summary> <para type="description">The version of the document object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.Lng"> <summary> <para type="description">The language of the document object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.Resolution"> <summary> <para type="description">The resolution of the document object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the document object is removed.</para> <para type="description">If the metadata is not the same anymore, an error is given and the document object is not removed.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.IshObject"> <summary> <para type="description">Array with the objects to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> TODO [Should] Promote parameter IshObject to IshObject[] processing </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.Force"> <summary> <para type="description">When the Force switch is set, after deleting the language object, the version object and logical object will be deleted if they don't have any language objects anymore</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.RemoveIshDocumentObj.ProcessRecord"> <summary> Process the Remove-IshDocumentObj commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj"> <summary> <para type="synopsis">Search - so Full-Text-Index as data source, while Find is Relational Database as data source - matching the search criteria. Metadata is retrieved like Get-IshDocumentObj would, from the Relational Database.</para> <para type="description">Search - so Full-Text-Index as data source, while Find is Relational Database as data source - matching the search criteria. Metadata is retrieved like Get-IshDocumentObj would, from the Relational Database.</para> <para type="description">Passes the search criteria to the Search25 API where the result set is capped by -MaxHitsToReturn. See online documentation for advanced query support on this 'ishquery' domain specific language.</para> <para type="description">Then the search results is enriched using the DocumentObj25 API to retrieve ishobjects. As the output are IshObjects on the pipeline any further handling by other ISHRemote cmdlets or more is enabled.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Search-IshDocumentObj -SimpleQuery "bluetooth" -MaxHitsToReturn 200 </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for 'bluetooth' in the ANY field of the LatestVersion collection (compared to AllVersion), with no filter on object types and only in the user's language. The MaxHitsToReturn limits the Full-Text-Index result set.</para> <para>Results are returned sorted by the Full-Text-Index engine, first by score then by title.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Search-IshDocumentObj -SimpleQuery "bluetooth" -Count </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for 'bluetooth' in the ANY field of the LatestVersion collection (compared to AllVersion), with no filter on object types and only in the user's language.</para> <para>Results a count of hits, there are no IshObjects on the pipeline (MaxHitsToReturn is 0).</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Search-IshDocumentObj -SimpleQuery "*" -MaxHitsToReturn 2000 | Out-GridView -PassThru </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for '*' in the ANY field of the LatestVersion collection (so all latest version content objects are returned), with no filter on object types and only in the user's language. The MaxHitsToReturn limits the Full-Text-Index result set.</para> <para>Results are passed to Out-GridView where manual filtering can happen and the selection is passed to the pipeline for further processing.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Search-IshDocumentObj -SimpleQuery "red AND green AND blue" | Get-IshDocumentObjData -FolderPath c:\temp\ </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for 'red AND green AND blue' in the ANY field of the LatestVersion collection (compared to AllVersion), with no filter on object types and only in the user's language. Note that the AND keyword is recognized as boolean operator for the ISHANYWHERE field, see API documentation.</para> <para>Results are returned sorted by the Full-Text-Index engine, first by score then by title. And this IshObjects are passed to Get-IshDocumentObjData for (xml) file downloading.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $xmlQuery = @" <ishquery> <and><ishfield name='ISHANYWHERE' level='none' ishoperator='contains'>change oil filter</ishfield></and> <ishsort> <ishsortfield name='ISHSCORE' level='none' ishorder='d'/> <ishsortfield name='FTITLE' level='logical' ishorder='d'/> </ishsort> <ishobjectfilters> <ishversionfilter>LatestVersion</ishversionfilter> <ishtypefilter>ISHModule</ishtypefilter> <ishtypefilter>ISHMasterDoc</ishtypefilter> <ishtypefilter>ISHLibrary</ishtypefilter> <ishtypefilter>ISHTemplate</ishtypefilter> <ishtypefilter>ISHIllustration</ishtypefilter> <ishlanguagefilter>en</ishlanguagefilter> </ishobjectfilters> </ishquery> "@ $requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE Search-IshDocumentObj -XmlQuery $xmlQuery -MaxHitsToReturn 100 -RequestedMetadata $requestedMetadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for 'change oil filter' in the ANY field of the LatestVersion collection (compared to AllVersion), filtered on these object types and language; results are returned sorted by the Full-Text-Index engine, and enriched with FISHSTATUSTYPE field on top of the $ishSession.DefaultRequestedMetadata</para> <para>The provided $xmlQuery is the default query of parameter set lead by -SimpleQuery; where the ISHANYWHERE is overwritten with the given -SimpleQuery value, and the ishlanguagefilter is overwritten with the user's language.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $xmlQuery = @" <ishquery> <and><ishfield name='ISHANYWHERE' level='none' ishoperator='contains'>change oil filter</ishfield></and> <ishsort> <ishsortfield name='ISHSCORE' level='none' ishorder='d'/> <ishsortfield name='FTITLE' level='logical' ishorder='d'/> </ishsort> <ishobjectfilters> <ishversionfilter>LatestVersion</ishversionfilter> <ishtypefilter>ISHModule</ishtypefilter> <ishtypefilter>ISHMasterDoc</ishtypefilter> <ishtypefilter>ISHLibrary</ishtypefilter> <ishtypefilter>ISHTemplate</ishtypefilter> <ishtypefilter>ISHIllustration</ishtypefilter> <ishlanguagefilter>en</ishlanguagefilter> </ishobjectfilters> </ishquery> "@ $requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE Search-IshDocumentObj -XmlQuery $xmlQuery -Count </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>Executes a Full-Text-Index search for 'change oil filter' in the ANY field of the LatestVersion collection (compared to AllVersion), filtered on these object types and language.</para> <para>Results a count of hits, there are no IshObjects on the pipeline (MaxHitsToReturn is 0).</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.SimpleQuery"> <summary> <para type="description">The RAW xml ishquery used by Search25 API</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.XmlQuery"> <summary> <para type="description">The RAW xml ishquery used by Search25 API</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.MaxHitsToReturn"> <summary> <para type="description">The maximum amount of hits to return on the pipeline as IshObject[].</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.Count"> <summary> <para type="description">Switch parameter that specifies to only return the count of the query and not IshObject[]</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj._simpleQuery"> <summary> Private field to store the simple ISHANYWHERE query to later construct the XmlQuery </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj._xmlQuery"> <summary> Private field to store the incoming >ishquery< that is litteraly passed into Search25 API. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj._maxHitsToReturn"> <summary> Private field to store the amount of search results to push back on the pipeline </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj._onlyCount"> <summary> Private field to store if only a Count query should be executed, so without returning any results on the pipeline </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.SearchIshDocumentObj.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj"> <summary> <para type="synopsis">The Set-IshDocumentObj cmdlet updates the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to update all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Set-IshPublicationOutput.</para> <para type="description">The Set-IshDocumentObj cmdlet updates the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to update all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Set-IshPublicationOutput.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential Admin Get-IshDocumentObj -IshSession $ishSession -LogicalId ISHPUBLMODULECOMBINELANGUAGES | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -ValueType "Element" -Value "VSTATUSTOBEREVIEWED" | Set-IshDocumentObj -IshSession $ishSession | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -ValueType "Element" -Value "VSTATUSRELEASED" | Set-IshDocumentObj -IshSession $ishSession </code> <para>For all versions and languages retrieved, push them to status 'To Be Reviewed' and immediately to 'Release'. Note that also Find-IshDocumentObj or Get-IshFolderContent are ways to get to content objects.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "Username" -IshUserPassword "Password" $ishFolderTopic = Add-IshFolder -ParentFolderId (Get-IshFolder -BaseFolder Data).IshFolderRef -FolderType ISHModule -FolderName "TopicFolder" $ishTopicMetadata = Set-IshMetadataField -Name "FTITLE" -Level Logical -Value "My test Topic" | Set-IshMetadataField -Name "FAUTHOR" -Level Lng -ValueType Value -Value "Username" | Set-IshMetadataField -Name "FSTATUS" -Level Lng -ValueType Element -Value "VSTATUSDRAFT" $ditaTopicFileContent = @" <?xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.</title><body><p>This is the start of your topic</p></body></topic> "@ $ishObject = Add-IshDocumentObj -FolderId $ishFolderTopic.IshFolderRef -IshType ISHModule -Lng "en" -Metadata $ishTopicMetadata -FileContent $ditaTopicFileContent $ishObject = $ishObject | Set-IshDocumentObj -Metadata(Set-IshMetadataField -Name "FTITLE" -Level Lng -Value "Updated topic title") </code> <para>Create a topic in a folder and then overwrite its metadata (FTITLE) using piped IshObject to the Set-IshDocumentObj cmdlet. New-IshSession will submit into SessionState, so it can be reused by all cmdlets.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "Username" -IshUserPassword "Password" $ishFolderTopic = Add-IshFolder -ParentFolderId(Get-IshFolder -BaseFolder Data).IshFolderRef -FolderType ISHModule -FolderName "TopicFolder" $ishTopicMetadata = Set-IshMetadataField -Name "FTITLE" -Level Logical -Value "My test Topic" | Set-IshMetadataField -Name "FAUTHOR" -Level Lng -ValueType Value -Value "Username" | Set-IshMetadataField -Name "FSTATUS" -Level Lng -ValueType Element -Value "VSTATUSDRAFT" $ditaTopicFileContent = @" <?xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.</title><body><p>This is the start of your topic</p></body></topic> "@ $ditaTopicFileContentUpdated = @" <? xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.</title><body><p>This is the start of your topic(updated)</p></body></topic> "@ $ishObject = Add-IshDocumentObj -FolderId $ishFolderTopic.IshFolderRef -IshType ISHModule -Lng "en" -Metadata $ishTopicMetadata -FileContent $ditaTopicFileContent $ishObject = Set-IshDocumentObj -LogicalId $ishObject.IshRef ` -Version $ishObject.version_version_value ` -Lng $ishObject.doclanguage ` -FileContent $ditaTopicFileContentUpdated ` -Metadata(Set-IshMetadataField -Name "FTITLE" -Level Logical -Value "Updated topic title and content") </code> <para>Create a topic in a folder and then overwrite its metadata (FTITLE) and blob by providing parameters and FileContent value to the Set-IshDocumentObj cmdlet. New-IshSession will submit into SessionState, so it can be reused by all cmdlets.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "Username" -IshUserPassword "Password" $ishFolderTopic = Add-IshFolder -ParentFolderId(Get-IshFolder -BaseFolder Data).IshFolderRef -FolderType ISHModule -FolderName "TopicFolder" $ishTopicMetadata = Set-IshMetadataField -Name "FTITLE" -Level Logical -Value "My test Topic" | Set-IshMetadataField -Name "FAUTHOR" -Level Lng -ValueType Value -Value "Username" | Set-IshMetadataField -Name "FSTATUS" -Level Lng -ValueType Element -Value "VSTATUSDRAFT" $ditaTopicFileContent = @" <?xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.</title><body><p>This is the start of your topic</p></body></topic> "@ $ishObject = Add-IshDocumentObj -FolderId $ishFolderTopic.IshFolderRef -IshType ISHModule -Lng "en" -Metadata $ishTopicMetadata -FileContent $ditaTopicFileContent $tempFilePath = (New-TemporaryFile).FullName $ditaTopicFileContent.Replace("your topic", "my topic") | Out-File -FilePath $tempFilePath $ishObject = Set-IshDocumentObj -LogicalId $ishObject.IshRef ` -Version $ishObject.version_version_value ` -Lng $ishObject.doclanguage ` -FilePath $tempFilePath ` -Metadata(Set-IshMetadataField -Name "FTITLE" -Level Logical -Value "Updated topic title and content using file path") </code> <para>Create a topic in a folder and then overwrite its metadata (FTITLE) and blob by providing parameters and FilePath value to the Set-IshDocumentObj cmdlet. New-IshSession will submit into SessionState, so it can be reused by all cmdlets.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.LogicalId"> <summary> <para type="description">The logical identifier of the object to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.Version"> <summary> <para type="description">The version of the object to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.Lng"> <summary> <para type="description">The language of the object to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.Resolution"> <summary> <para type="description">The resolution of the object to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.Metadata"> <summary> <para type="description">The metadata to set for the document object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the metadata will be set.</para> <para type="description">If the metadata is not the same anymore, an error is given and the metadata will not be set.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.Edt"> <summary> <para type="description">The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.FilePath"> <summary> <para type="description">The location of the file on the filesystem containing new content (xml, jpg, etc.) for the object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.FileContent"> <summary> <para type="description">String with XML content of the DocumentObj</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.IshObject"> <summary> <para type="description">Array with the objects for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj._edt"> <summary> EDT will be defaulted to EDTXML. Needs to match up with FileContent or FilePath content. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.ProcessRecord"> <summary> Process the Set-IshDocumentObj cmdlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.DocumentObj.SetIshDocumentObj.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt"> <summary> <para type="synopsis">The Add-IshEDT cmdlet adds the new EDTs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshEDT cmdlet adds the new EDTs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -Name "MYEDT" -Metadata $metadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Add a new EDT</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt.Name"> <summary> <para type="description">Name for the new EDT</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt.Metadata"> <summary> <para type="description">MetaData - xml structure that will be used for the new EDT</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt.IshObject"> <summary> <para type="description">IshObject - contains EDT data that needs to be created. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EDT.AddIshEdt.ProcessRecord"> <summary> Process the Add-IshEDT commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt"> <summary> <para type="synopsis">The Find-IshEDT cmdlet finds EDT objects using ActivityFilter and MetadataFilter that are provided</para> <para type="description">The Find-IshEDT cmdlet finds EDT objects using ActivityFilter and MetadataFilter that are provided</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "None" -FilterOperator "Like" -Value "%xml%" $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "NAME" -Level "None" $edtList = Find-IshEDT ` -ActivityFilter "None" ` -MetadataFilter $ishMetadataFilterFields ` -RequestedMetadata $ishRequestedFields </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Find EDTs with names containing "edt" text</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.EDT.FindIshEdt._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt"> <summary> <para type="synopsis">The Get-IshEDT cmdlet retrieves the metadata of the EDTs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshEDT cmdlet retrieves the metadata of the EDTs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -IshSession $ishSession ` -Name "MYEDT" ` -Metadata $metadata $edtId = $edt[0].IshRef $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "NAME" -Level "None" $edtRetrieve = Get-IshEDT ` -Id @($edtId) ` -ActivityFilter "None" ` -RequestedMetadata $ishRequestedFields </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve Name of added EDT</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.Id"> <summary> <para type="description">Id - string array with IDs of the EDTs</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.IshObject"> <summary> <para type="description">Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EDT.GetIshEdt.ProcessRecord"> <summary> Process the Get-IshEDT commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EDT.RemoveIshEDT"> <summary> <para type="synopsis">The Remove-IshEDT cmdlet removes the EDTs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshEDT cmdlet removes the EDTs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -IshSession $ishSession ` -Name "MYEDT" ` -Metadata $metadata #Remove EDT using pipeline $edt | Remove-IshEDT </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Remove added EDT</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.RemoveIshEDT.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.RemoveIshEDT.Id"> <summary> <para type="description">The Id - element name of the EDT to be removed</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.RemoveIshEDT.IshObject"> <summary> <para type="description">The IshObject array containing EDTs that needs to be deleted. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EDT.RemoveIshEDT.ProcessRecord"> <summary> Process the Remove-IshEDT commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt"> <summary> <para type="synopsis">The Set-IshEDT cmdlet updates the EDTs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshEDT cmdlet updates the EDTs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $edtName = "MYEDT" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edtAdd = Add-IshEDT -IshSession $ishSession -Name $edtName -Metadata $metadata $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name "NAME" -Level "none" -Value ($edtName + " updated") $requiredCurrentMetadata = Set-IshRequiredCurrentMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" Set-IshEDT -RequiredCurrentMetadata $requiredCurrentMetadata -Metadata $metadataUpdate </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Add EDT and update name</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Set-IshEDT -IshSession $ishSession -Id EDTXML -Metadata (Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level None -ValueType Value -Value "xml, dita, ditamap") </code> <para>Adding .map and .ditamap to the EDTXML object. By adding these, tools like Content-Importer/DITA2Trisoft can import .xml, .dita and .ditamap files and they will all be assigned EDTXML as Electronic Document Type.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.Id"> <summary> <para type="description">EDT Element Name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.Metadata"> <summary> <para type="description">The metadata to set for the object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the metadata will be set.</para> <para type="description">If the metadata is not the same anymore, an error is given and the metadata will be set.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.IshObject"> <summary> <para type="description">Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EDT.SetIshEdt.ProcessRecord"> <summary> Process the Set-IshEDT commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent"> <summary> <para type="synopsis">Gets EventMonitor entries with filtering options.</para> <para type="description">Uses EventMonitor25 API to retrieve ishevents showing progress of background task events from the centralized log system.</para> <para type="description">This table oriented API maps straight through to database column names regarding ishfield usage.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $requestedMetadata = Set-IshRequestedMetadataField -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -Name "EVENTTYPE" -Level "Progress" Get-IshEvent -EventTypes @("EXPORTFORPUBLICATION","SYNCHRONIZETOLIVECONTENT") -RequestedMetadata $requestedMetadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets all top-level (progress) ishevents filtered to publish and synchronize events.</para> </example> <example> <code> $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTTYPE" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" -FilterOperator "NotEqual" -Value "10" Get-IshEvent -IshSession $ishSession -EventTypes @("EXPORTFORPUBLICATION","SYNCHRONIZETOLIVECONTENT") -RequestedMetadata $requestedMetadata -MetadataFilter $metadataFilter </code> <para>Gets up to detail ishevents filtered to publish and synchronize events and the eventdatatype should differ from 10.</para> </example> <example> <code> $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTTYPE" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name "ACTION" -Level "Detail" -FilterOperator In -Value "Request started, Start execution, Execution completed" Get-IshEvent -IshSession $ishSession -EventTypes @("EXPORTFORPUBLICATION") -RequestedMetadata $requestedMetadata -MetadataFilter $metadataFilter </code> <para>Gets up to detail ishevents filtered to publish events and filters to only have the queue event, processing started and processing ended. This allows calculation of lead times and through put.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.EventTypes"> <summary> <para type="description">String array containing the event types to retrieve (e.g. EXPORTFORPUBLICATION, PUSHTRANSLATIONS,...)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.ProgressStatusFilter"> <summary> <para type="description">The enumeration indicating which overall status the event must have (e.g. All, Success, Failed,...)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.ModifiedSince"> <summary> <para type="description">A date limiting the events that will be retrieved based on the last modification date of the events</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.UserFilter"> <summary> <para type="description">Enumeration indicating if only events of the current user or all events must be retrieved</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.MetadataFilter"> <summary> <para type="description">Filter on metadata to limit the objects on which metadata has to be returned</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.RequestedMetadata"> <summary> <para type="description">XML structure indicating which metadata has to be retrieved.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.EventLevel"> <summary> <para type="description">Possible values for the level of an event detail.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.IshEvent"> <summary> <para type="description">The <see cref="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.IshEvent"/>s that need to be handled.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.EndProcessing"> <summary> Process the cmdlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="P:Trisoft.ISHRemote.Cmdlets.EventMonitor.GetIshEvent.IshEvent"/> to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Feature.FeatureCmdlet"> <summary> Abstract class used for the feature commandlets for condition filtering usage </summary> <remarks>Inherits from <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/>.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Feature.SetIshFeature"> <summary> <para type="synopsis">The Set-IshFeature cmdlet creates a new IshFeature based on the parameters provided. When IshFeature[] object is passed through the pipeline then the new feature is added based on the parameters provided</para> <para type="description">The Set-IshFeature cmdlet creates a new IshFeature based on the parameters provided. When IshFeature[] object is passed through the pipeline then the new feature is added based on the parameters provided</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $ishFeatures = Set-IshFeature -Name "ISHRemoteStringCond" -Value "StringOne" | Set-IshFeature -Name "ISHRemoteVersionCond" -Value "12.0.1" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Build a Condition Context for passing to Get-DocumentObjData.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Feature.SetIshFeature.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Feature.SetIshFeature.Name"> <summary> <para type="description">The condition name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Feature.SetIshFeature.Value"> <summary> <para type="description">The condition value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Feature.SetIshFeature.IshFeature"> <summary> <para type="description">The set of condition names and values</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.FieldCmdlet"> <summary> Abstract class used for the field commandlets for requested, filtering and value field entries. </summary> <remarks>Inherits from <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/>.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField"> <summary> <para type="synopsis">The Get-IshMetadataField -IshSession $ishSession cmdlet return the value of a field with a certain name, level and value type.</para> <para type="description">The Get-IshMetadataField -IshSession $ishSession cmdlet return the value of a field with a certain name, level and value type. Best practice is to supply IshSession for future functionality.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUser -IshSession $ishSession | Get-IshMetadataField -IshSession $ishSession -Name "USERNAME" </code> <para>Retrieves your username from the return IshUser object. The Get-IshMetadataField defaults to level None and type value.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.Name"> <summary> <para type="description">The field name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.Level"> <summary> <para type="description">The field level</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshField"> <summary> <para type="description">The fields container object, accepts multiple ISHFields objects</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshObject"> <summary> <para type="description">The objects container object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshFolder"> <summary> <para type="description">The objects container object, specialized for folder handling</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshEvent"> <summary> <para type="description">The objects container object, specialized for event handling</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField.IshBackgroundTask"> <summary> <para type="description">The objects container object, specialized for event handling</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Field.GetIshMetadataField._level"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.SetIshField"> <summary> <para type="synopsis">The Set-IshField cmdlet sets/merges the IshFields * If an IshObject[] array parameter is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to all the IshFields of all the objects, and the objects are returned * If an IshFields object is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to the IshFields object and the resulting fields are returned * If none of the above applies, the fields in the MergeFields are returned</para> <para type="description">The Set-IshField cmdlet sets/merges the IshFields * If an IshObject[] array parameter is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to all the IshFields of all the objects, and the objects are returned * If an IshFields object is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to the IshFields object and the resulting fields are returned * If none of the above applies, the fields in the MergeFields are returned Best practice is to supply IshSession for future functionality.</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $ishMetadataFieldsAction = Set-IshMetadataField -Name "FISHUSERDISABLED" -Level "none" -ValueType "Element" -Value "TRUE" | Set-IshMetadataField -Name "FISHOBJECTACTIVE" -Level "none" -ValueType "Element" -Value "FALSE" $ishobject = $ishobject | Set-IshField -MergeFields $ishMetadataFieldsAction -ValueAction "Overwrite" | Set-IshUser -IshSession $ishSession </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Preferably use the specialized IshField cmdlets, more for testing purposes this one.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshField.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshField.MergeField"> <summary> <para type="description">The IshField[] to merge</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshField.ValueAction"> <summary> <para type="description">Whether the fields in the mergefields parameter will be prepended, appended or overwrite the values in the provided IshFields or IshObject objects</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshField.IshObject"> <summary> <para type="description">Objects to merge the fields in</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshField.IshField"> <summary> <para type="description">Fields to merge the mergefields in</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Field.SetIshField._valueAction"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField"> <summary> <para type="synopsis">The Set-IshMetadataField -IshSession $ishSession cmdlet creates value fields based on the parameters provided When IshFields object is passed through the pipeline then new value field is added according to the parameters provided.</para> <para type="description">The Set-IshMetadataField -IshSession $ishSession cmdlet creates value fields based on the parameters provided When IshFields object is passed through the pipeline then new value field is added according to the parameters provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshMetadataField -IshSession $ishSession -Name "USERNAME" </code> <para>Creates an IshFields structure holding one IshMetadataField with name USERNAME and defaults to level None.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.Name"> <summary> <para type="description">The field name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.Level"> <summary> <para type="description">The field level</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.Value"> <summary> <para type="description">The field value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.IshField"> <summary> <para type="description">The fields container object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.IshObject"> <summary> <para type="description">The objects container object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.IshFolder"> <summary> <para type="description">The objects container object, specialized for folder handling</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField.IshEvent"> <summary> <para type="description">The objects container object, specialized for event handling</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataField._level"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField"> <summary> <para type="synopsis">The Set-IshMetadataFilterField cmdlet creates filter fields based on the parameters provided When IshFields object is passed through the pipeline then new filter field is added according to the parameters provided.</para> <para type="description">The Set-IshMetadataFilterField cmdlet creates filter fields based on the parameters provided When IshFields object is passed through the pipeline then new filter field is added according to the parameters provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshMetadataFilterField -IshSession $ishSession -Name "USERNAME" </code> <para>Creates an IshFields structure holding one IshMetadataFilterField with name USERNAME and defaults to level None, FilterOperator Equal and type Value.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.Name"> <summary> <para type="description">The field name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.Level"> <summary> <para type="description">The field level</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.FilterOperator"> <summary> <para type="description">The filter operator to use</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.Value"> <summary> <para type="description">The value to use for filtering</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField.IshField"> <summary> <para type="description">The fields container object</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Field.SetIshMetadataFilterField._level"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField"> <summary> <para type="synopsis">The Set-IshRequestedMetadataField cmdlet creates a field with a certain name, level and value type When IshFields object is passed through the pipeline then the new field is added to that object.</para> <para type="description">The Set-IshRequestedMetadataField cmdlet creates a field with a certain name, level and value type When IshFields object is passed through the pipeline then the new field is added to that object.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshRequestedMetadataField -IshSession $ishSession -Name "USERNAME" </code> <para>Creates an IshFields structure holding one IshRequestedMetadataField with name USERNAME and defaults to level None.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField.Name"> <summary> <para type="description">The field name</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField.Level"> <summary> <para type="description">The field level</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField.IshField"> <summary> <para type="description">The fields container object</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Field.SetIshRequestedMetadataField._level"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml"> <summary> <para type="synopsis">The New-IshDitaGeneralizedXml cmdlet generalizes all incoming files. Both the specialized input xml file and resulting generalized xml output file are validated.</para> <para type="description">The New-IshDitaGeneralizedXml cmdlet generalizes all incoming files. Both the specialized input xml file and resulting generalized xml output file are validated. Note that a DOCTYPE needs to be present in the input xml file and resulting generalized xml output file are validated.</para> </summary> <example> <code> # This sample script will process all DITA xml files in the input folder and will generalize all DITA files either to Topic or Map. # Note that ditabase and ditaval are not supported. # Note that the xmls in the input folder needs to have a DOCTYPE. # Input folder with the specialized xmls to generalize. $inputfolder = "Data-GeneralizeDitaXml\InputFiles" # Output folder with the generalize xmls. $outputfolder = "Data-GeneralizeDitaXml\OutputFiles" # Location of the catalog xml that contains the specialized dtds $specializedCatalogLocation = "Samples\Data-GeneralizeDitaXml\SpecializedDTDs\catalog-alldita12dtds.xml" # Location of the catalog xml that contains the "base" dtds $generalizedCatalogLocation = "Samples\Data-GeneralizeDitaXml\GeneralizedDTDs\catalog-dita12topic&maponly.xml"; # File that contains a mapping between the specialized dtd and the according generalized dtd. $generalizationCatalogMappingLocation = "Samples\Data-GeneralizeDitaXml\generalization-catalog-mapping.xml" # If you would have specialized attributes from the DITA 1.2 "props" attribute, specify those attributes here to generalize them to the "props" attribute again. Here just using modelyear, market, vehicle as an example $attributesToGeneralizeToProps = @("modelA", "modelB", "modelC") # If you would have specialized attributes from the DITA 1.2 "base" attribute, specify those attributes here to generalize them to the "base" attribute again. Here just using basea, baseb, basec as an example $attributesToGeneralizeToBase = @("basea", "baseb", "basec") # Read all the xml files to process and generalize all the files in the outputfolder Get-ChildItem $inputfolder -Include *.xml -Recurse | New-IshDitaGeneralizedXml -SpecializedCatalogFilePath $SpecializedCatalogFilePath ` -GeneralizedCatalogFilePath $GeneralizedCatalogFilePath ` -GeneralizationCatalogMappingFilePath $GeneralizationCatalogMappingFilePath ` -AttributesToGeneralizeToProps $attributesToGeneralizeToProps ` -AttributesToGeneralizeToBase $attributesToGeneralizeToBase ` -FolderPath $outputfolder </code> <para>Generalize all DITA xml files in a certain directory</para> </example> <example> <code> $someLearningAssessmentFilePath = "Samples\InputFiles\Learning\LearningAssessment.xml" $outputfolder = "C:\temp\" $specializedCatalogLocation = "Samples\SpecializedDTDs\catalog-dita-1.2.xml" $generalizedCatalogLocation = "Samples\GeneralizedDTDs\catalog-dita-1.1.xml" $generalizationCatalogMappingLocation = "Samples\generalization-catalog-mapping.xml"; $attributesToGeneralizeToProps = @("complexity", "visibility") # array containing 2 elements $attributesToGeneralizeToBase = @(); # @() = empty array New-IshDitaGeneralizedXml -SpecializedCatalogFilePath $SpecializedCatalogFilePath ` -GeneralizedCatalogFilePath $GeneralizedCatalogFilePath ` -GeneralizationCatalogMappingFilePath $GeneralizationCatalogMappingFilePath ` -AttributesToGeneralizeToProps $attributesToGeneralizeToProps ` -AttributesToGeneralizeToBase $attributesToGeneralizeToBase -FilePath $someLearningAssessmentFilePath ` -FolderPath $outputfolder </code> <para>Generalize one DITA xml file</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.SpecializedCatalogFilePath"> <summary> <para type="description">The filepath of the catalog with the specialized DTDs. Best is to make a separate folders with all the specialized DTD files together + a catalog with relative locations to the specialized DTD files.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.GeneralizedCatalogFilePath"> <summary> <para type="description">The filepath of the catalog with the generalized/standard DTDs. Best is to make a separate folders with all the generalized DTD files together + a catalog with relative locations to the generalized DTD files.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.GeneralizationCatalogMappingFilePath"> <summary> <para type="description">The location of a generalization mapping file. This mapping file defines the relation between the specialized dtd rootelements/public ids and the corresponding generalized dtd rootelements/public ids. It is of the following form: <generalizationcataloglookup> <match rootelement="learningSummary" dtdpublicid="-//OASIS//DTD DITA Learning Summary//EN" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> <match rootelement="learningContent" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> ... </generalizationcataloglookup> The rootelement, dtdpublicid or dtdsystemid attributes are used to match the specialized xml rootelement or dtd, while the generalizedrootelement, generalizeddtdpublicid or generalizeddtdsystemid are used to specify the corresponding generalized rootelement/dtd. Note that: 1) At least one of the specialized attributes is required 2) The generalizedrootelement is required 3) Either the generalizeddtdpublicid or generalizeddtdsystemid is required</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.AttributesToGeneralizeToProps"> <summary> <para type="description">Array of attributes that are specialized from the DITA "props" attribute (and need to be generalized to it).</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.AttributesToGeneralizeToBase"> <summary> <para type="description">Array of attributes that are specialized from the DITA "base" attribute (and need to be generalized to it).</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.FilePath"> <summary> <para type="description">FilePath can be used to specify one or more specialized input xml file locations.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.FolderPath"> <summary> <para type="description">Folder on the Windows filesystem where to store the new data files</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml._ditaXMLGeneralization"> <summary> Single conversion object </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml._files"> <summary> Collection of the files to process </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshDitaGeneralizedXml.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile"> <summary> <para type="synopsis">The New-IshObfuscatedFile cmdlet can be used to obfuscate the text in xml files or replace images with a generated image of the same format, width and height.</para> <para type="description"> The New-IshObfuscatedFile cmdlet can be used to: 1. For all files having a file extension that is present in XmlFileExtensions: All the words in the text of all xml files are replaced with hardcoded words of the same length. This includes the text in elements, the comments and the processing instructions. Optionally, you can specifiy the names of attributes in the XmlAttributesToObfuscate parameter for which the values need to be obfuscated as well. By default, attribute values are not obfuscated, as some attribute values are limited to a certain list of values defined in the DTD. Note that an obfuscated xml is not validated against it's DTD or schema. 2. For all files having a file extension that is present in ImageFileExtensions A new image is created with the same format, width and height as the original image. The new image will have a yellow background (and the filename in text in the image if it is wide enough to put it there). 3. For all files NOT having a file extension that is present in XmlImageExtensions or ImageFileExtensions A warning message is given on the console that the file could not be obfuscated It will do that for all files that are passed through the pipeline or via the -FilePath parameter. Only the successfully obfuscated files will be saved to the output folder with the same name, overwriting the file with the same name if that is already present When the obfuscation fails or if there is no obfuscator for the given file extension, a warning message is given on the console that the file could not be obfuscated You can specify which file extensions should be treated as xml, by specifying the XmlFileExtensions parameter. By default these are ".xml", ".dita", ".ditamap". You can specify which file extensions should be treated as image, by specifying the XmlFileExtensions parameter. By default these are ".png", ".gif", ".bmp", ".jpg", ".jpeg". </para> </summary> <example> <code> # This sample script will process all files in the input folder and save the obfuscated xml and image files in the output folder # Other type of files like .mpg, .mov, .swf etc. are not supported by the obfuscator, so will not be present in the output folder Note that the script deletes all the files in the output folder first # Input folder with the files to obfuscate $inputfolder = "Samples\Data-ObfuscateFiles\InputFiles" # Output folder with the obfuscated files. $outputfolder = "Samples\Data-ObfuscateFiles\OutputFiles" # Read all files to process from the inputfolder Get-ChildItem $inputfolder -File | New-IshObfuscatedFile -OutputFolder $outputfolder -XmlAttributesToObfuscate @("navtitle") </code> <para>Obfuscates all xml and image files in a certain directory</para> </example> <example> <code> $xhtmlFilePath = "C:\temp\test.html"; # Since we know that the .html file contains xhtml which can be loaded as xml, add it to the file extensions that should be treated as xml New-IshObfuscatedFile -OutputFolder "c:\out\" -FilePath $xhtmlFilePath -XmlFileExtensions @(".html") -XmlAttributesToObfuscate @() # @() = empty array </code> <para>Obfuscates one xhtml file</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.FilePath"> <summary> <para type="description">FilePath can be used to specify one or more input xml file location.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.FolderPath"> <summary> <para type="description">Folder on the Windows filesystem where to store the new data files</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.XmlFileExtensions"> <summary> <para type="description">The file extensions that should be treated as an xml.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.ImageFileExtensions"> <summary> <para type="description">The file extensions that should be treated as an image.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.XmlAttributesToObfuscate"> <summary> <para type="description">Array of attribute names for which the values need to be obfuscated as well.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile._xmlFileExtensions"> <summary> Private field to store the file extensions that should be treated as an xml </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile._imageFileExtensions"> <summary> Private field to store the file extensions that should be treated as an image </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile._xmlAttributesToObfuscate"> <summary> Private field to store the file extensions that should be treated as an image </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile._files"> <summary> Collection of the files to process </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.ProcessRecord"> <summary> Process the cmdlet. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.FileProcessor.NewIshObfuscatedFile.EndProcessing"> <summary> Process the cmdlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes <see cref="T:System.IO.FileInfo"/> to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml"> <summary> <para type="synopsis">The Test-IshValidFile checks wellformedness and validness using the given xml catalog.</para> <para type="description">Quick test to validate the given xml using the DocTypes/DTDs specified through catalog.xml.</para> </summary> <example> <code>Get-ChildItem -Path C:\temp\*.xml | Test-IshValidXml -XmlCatalogFilePath C:\InfoShare\WebDITA\Author\ASP\DocTypes\catalog.xml </code> <para>All xml files will get a Boolean True/False back from the Test-cmdlet using a local file system catalog and DTDs.</para> </example> <example> <code>Test-IshValidXml -XmlCatalogFilePath https://example.com/ISHCM/DocTypes/catalog.xml -FilePath C:\temp\somefile.xml </code> <para>Single xml file will get a single Boolean True/False back from the Test-cmdlet using a remote https accessible catalog and DTDs. Note that this option is SLOW as every catalog, dtd, ent, mod file required will be downloaded over-and-over again - but it does work.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml.XmlCatalogFilePath"> <summary> <para type="description">XmlCatalogFilePath should point to the leading catalog.xml file. For example C:\InfoShare\Web\Author\ASP\DocTypes\catalog.xml</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml.FilePath"> <summary> <para type="description">FilePath can be used to specify one or more input xml file location.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml._xmlReaderSettings"> <summary> XmlReaderSettings that hold the processing types and xml catalog references. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml._files"> <summary> Collection of the files to process </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.FileProcessor.TestIshValidXml.ValidationHandler(System.Object,System.Xml.Schema.ValidationEventArgs)"> <summary> Handler method for validation errors. Throws an exception when an error is encountered </summary> <param name="sender">Sender of the validation event</param> <param name="args">Validation error arguments</param> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder"> <summary> <para type="synopsis">The Add-IshFolder cmdlet adds the new folders that are passed through the pipeline or determined via provided parameters. Query and Reference folders are not supported.</para> <para type="description">The Add-IshFolder cmdlet adds the new folders that are passed through the pipeline or determined via provided parameters. Query and Reference folders are not supported.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderName = "New folder created by powershell" $parentFolderId = "7775" # provide a valid parent folder Id $ishFolders = Add-IshFolder ` -ParentFolderId $parentFolderId ` -FolderType "ISHModule" ` -FolderName $folderName ` -ReadAccess @("") ` -OwnedBy "" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Add a folder using input parameters</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.ParentFolderId"> <summary> <para type="description">The identifier of the parent folder where the new folder will be created</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.FolderType"> <summary> <para type="description">The Type of the new Folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.FolderName"> <summary> <para type="description">The Name of the new Folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.OwnedBy"> <summary> <para type="description">The name of the UserGroup that will be the owner of the new folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.ReadAccess"> <summary> <para type="description">Array with the UserGroups that have ReadAccess to the new folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.IshFolder"> <summary> <para type="description">The IshFolder array that needs to be created. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.ProcessRecord"> <summary> Process the Add-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.Folder.AddIshFolder.IshFolder"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder"> <summary> <para type="synopsis">The Get-IshFolder cmdlet retrieves metadata for the folders by providing one of the following input data: - FolderPath string with the separated full folder path - FolderIds array containing identifiers of the folders - BaseFolder enum value referencing the specified root folder - IshFolder[] array passed through the pipeline Query and Reference folders are not supported.</para> <para type="description">The Get-IshFolder cmdlet retrieves metadata for the folders by providing one of the following input data: - FolderPath string with the separated full folder path - FolderIds array containing identifiers of the folders - BaseFolder enum value referencing the specified root folder - IshFolder[] array passed through the pipeline Query and Reference folders are not supported.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential Admin Get-IshFolder -FolderPath "\General\__ISHRemote\Add-IshPublicationOutput\Pub" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Returns the IshFolder object.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential Admin (Get-IshFolder -BaseFolder Data).name </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Returns the name of the root data folder, typically called 'General'.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $requestedMetadata = Set-IshMetadataFilterField -Name "FNAME" -Level "None" $folderId = 7598 # provide a real folder identifier $ishFolder = Get-IshFolder -FolderId $folderId -RequestedMetaData $requestedMetadata $retrievedFolderName = $ishFolder.name </code> <para>Get folder name using Id with explicit requested metadata</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $ishFolders = Get-IshFolder -FolderPath "General\Myfolder" -FolderTypeFilter @("ISHModule", "ISHMasterDoc", "ISHLibrary") -Recurse </code> <para>Get folders recursively with filtering on folder type</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" $imageCount = 0 $xmlCount = 0 Get-IshFolder -FolderPath "General\Myfolder" -FolderTypeFilter @("ISHIllustration", "ISHModule", "ISHMasterDoc", "ISHLibrary") -Recurse | Get-IshFolderContent -VersionFilter "" | ForEach-Object -Process { if ($_.IshType -in @("ISHIllustration")) { ++$imageCount } if ($_.IshType -in @("ISHModule", "ISHMasterDoc", "ISHLibrary")) { ++$xmlCount } } Write-Host ("imageCount["+$imageCount+"]") Write-Host ("xmlCount["+$xmlCount+"]") </code> <para>Various statistics can be gathered by crawling across many API calls. This sample recursively goes over some subfolder, and retrieves all content objects in the folder and aggregates to a rough count. The ForEach-Object construct is important as it only keeps the essence, the counters, and avoids keeping all objects retrieved over the API in memory - potentially running out of client-side/PowerShell memory.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.FolderPath"> <summary> <para type="description">Separated string with the full folder path, e.g. "General\Project\Topics"</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.FolderId"> <summary> <para type="description">Unique folder identifier</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.BaseFolder"> <summary> <para type="description">The BaseFolder enumeration to get subfolders for the specified root folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.IshFolder"> <summary> <para type="description">Folders for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.Recurse"> <summary> <para type="description">Perform recursive retrieval of the provided incoming folder(s)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.Depth"> <summary> <para type="description">Perform recursive retrieval of up to Depth of the provided incoming folder(s)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.FolderTypeFilter"> <summary> <para type="description">Recursive retrieval will loop all folder, this filter will only return folder matching the filter to the pipeline</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder._retrievedIshFolders"> <summary> Initially holds incoming IshObject entries from the pipeline to correct the incorrect array-objects from Trisoft.Automation </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder._retrievedFolderIds"> <summary> Initially holds incoming folder id entries from the pipeline to correct the incorrect array-objects from Trisoft.Automation </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder._requestedMetadata"> <summary> Requested metadata to be shared across all (recursive) calls </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder._maxDepth"> <summary> Initially set to max recursive depth we can handle </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.ProcessRecord"> <summary> Process the Get-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.EndProcessing"> <summary> Process the Get-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolder.IshFolder"/> object to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent"> <summary> <para type="synopsis">The Get-IshFolderContent cmdlet returns all document objects or publication outputs stored inside a given folder. You can provide filters to reduce the amount of objects returned, but if you don't provide any: * The cmdlet will return an object for all the latest versions in all language and resolution for a document object folder * The cmdlet will return an object for all the latest versions for all output formats and all language combinations for a publication folder Note: The default value of the VersionFilter is "latest". In order to get all versions, you need to pass an empty string in the VersionFilter.</para> <para type="description">The Get-IshFolderContent cmdlet returns all document objects or publication outputs stored inside a given folder. You can provide filters to reduce the amount of objects returned, but if you don't provide any: * The cmdlet will return an object for all the latest versions in all language and resolution for a document object folder * The cmdlet will return an object for all the latest versions for all output formats and all language combinations for a publication folder. Note: The default value of the VersionFilter is "latest". In order to get all versions, you need to pass an empty string in the VersionFilter.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $folderId = 7775 #use correct folder id $ishObjects = Get-IshFolderContent -FolderId $folderId </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve contents of a given folder</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $metadataFilter = Set-IshMetadataFilterField -Level Lng -Name FSTATUS -ValueType Element -FilterOperator In -Value 'VSTATUSTOBETRANSLATED, VSTATUSINTRANSLATION' | Set-IshMetadataFilterField -Level Lng -Name FSOURCELANGUAGE -FilterOperator NotEmpty Get-IshFolder -FolderPath "\General\Mobile Phones Demo" -Recurse | Get-IshFolderContent -MetadataFilter $metadataFilter </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. The metadata filter will filter out target languages/stubs in a certain status (in this example probably the ones holding deprecated pretranslation). The recursive folder allows you to control which area you do a check/conversion in, and give you progress as well.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $metadataFilter = Set-IshMetadataFilterField -Level Lng -Name FSOURCELANGUAGE -FilterOperator Empty Get-IshFolder -FolderPath "\General\Mobile Phones Demo" -Recurse | Get-IshFolderContent -VersionFilter LATEST -MetadataFilter $metadataFilter </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. The metadata filter will filter out source languages/stubs and the VersionFilter will only return latest versions of any object. The recursive folder allows you to control which area you do a check/conversion in, and give you progress as well.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $metadataFilter = Set-IshMetadataFilterField -Level Lng -Name FSOURCELANGUAGE -FilterOperator Empty $requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE Get-IshFolder -FolderPath "\General\Mobile Phones Demo" -Recurse | Get-IshFolderContent -VersionFilter "" -MetadataFilter $metadataFilter -RequestedMetadata $requestedMetadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. The metadata filter will filter out source languages and the empty VersionFilter will return all versions of any object. The recursive folder allows you to control which area you do a check/conversion in, and give you progress as well.</para> <para>Note that -RequestedMetadata will be used on every folder passed over the pipeline by Get-IshFolder. Requesting metadata for Topics (ISHModule) might be unexisting on Publication folders or vice versa. Know that Get-IshFolder has a -FolderTypeFilter parameter to workaround that.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $ishSession.MetadataBatchSize = 100 $DebugPreference = "Continue" Get-IshFolderContent -IshSession $ishSession -FolderPath "General\MyPublication\FolderWithManyTopics" </code> <para>Retrieve the latest version of content objects in smaller batches to avoid "heavy" WebService calls to the server. The progress could be seen in the debug messages</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.FolderPath"> <summary> <para type="description">Separated string with the full folder path</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.FolderId"> <summary> <para type="description">Identifier of the folder for which to retrieve the content</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.BaseFolder"> <summary> <para type="description">The eBaseFolder enumeration to get subfolder(s) for the specified root folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.IshFolder"> <summary> <para type="description">Folder for which to retrieve the content. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.VersionFilter"> <summary> <para type="description">The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.LanguagesFilter"> <summary> <para type="description">The languages filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent._versionFilter"> <summary> Private field to store and provide defaults for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderContent.ProcessRecord"> <summary> Process the Get-IshFolderContent commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation"> <summary> <para type="synopsis">The Get-IshFolderLocation cmdlet returns the repository location of the folder objects in the form of a separated string e.g. "General\Folder1\Folder2"</para> <para type="description">The Get-IshFolderLocation cmdlet returns the repository location of the folder objects in the form of a separated string e.g. "General\Folder1\Folder2"</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $folderId = 7775 #provide valid folder identifier $folderPath = Get-IshFolderLocation -FolderId $folderId </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve folder location using provided Id</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.FolderPath"> <summary> <para type="description">Separated string with the full folder path</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.FolderId"> <summary> <para type="description">Identifier of the folder for which to retrieve the location</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.BaseFolder"> <summary> <para type="description">The eBaseFolder enumeration to get subfolder(s) for the specified root folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.IshFolder"> <summary> <para type="description">Folder that is passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.GetIshFolderLocation.ProcessRecord"> <summary> Process the Get-IshFolderLocation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes FolderPath string to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder"> <summary> <para type="synopsis">The Move-IshFolder cmdlet moves folders that are passed through the pipeline or determined via provided parameters to a different folder.</para> <para type="description">The Move-IshFolder cmdlet moves folders that are passed through the pipeline or determined via provided parameters to a different folder.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" Move-IshFolder -IshFolders (Get-IshFolder -FolderPath "General\__ISHRemote" -Recurse -Depth 2) -ToFolderId (Add-IshFolder...) </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Moves all folders listed under "General\__ISHRemote" to some other folder.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder.FolderId"> <summary> <para type="description">The folder identifier where the folder is currently located</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder.ToFolderId"> <summary> <para type="description">The folder identifier where to move the folder to</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder.IshFolders"> <summary> <para type="description">Array with the folders to move. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.MoveIshFolder.ProcessRecord"> <summary> Process the Move-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshFolder"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder"> <summary> <para type="synopsis">The Remove-IshFolder cmdlet removes the repository folders that are passed through the pipeline or determined via provided parameters Query and Reference folders are not supported.</para> <para type="description">The Remove-IshFolder cmdlet removes the repository folders that are passed through the pipeline or determined via provided parameters Query and Reference folders are not supported.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Remove-IshFolder -FolderId "674580" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Remove folder with specified Id</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.FolderPath"> <summary> <para type="description">Full path to the folder that needs to be removed. Use the IshSession.FolderPathSeparator.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.FolderId"> <summary> <para type="description">Identifier of the folder to be removed</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.IshFolder"> <summary> <para type="description">Array with the folders to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.Recurse"> <summary> <para type="description">Perform recursive retrieval of the provided incoming folder(s)</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.ProcessRecord"> <summary> Process the Remove-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.RemoveIshFolder.DeleteRecursive(Trisoft.ISHRemote.Objects.Public.IshFolder,System.Int32)"> <summary> Recursive delete of folder, expects folders to be empty </summary> <param name="ishFolder"></param> <param name="currentDepth"></param> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder"> <summary> <para type="synopsis">The Set-IshFolder cmdlet updates the folders that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshFolder cmdlet updates the folders that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $folderId = 655993 # provide real folder Id $newFolderName = "Updated Folder Name" $updatedFolder = Set-IshFolder -FolderId $folderId -NewFolderName $newFolderName </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Update name of a folder with provided FolderId</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.FolderPath"> <summary> <para type="description">Separated string with the full folder path</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.BaseFolder"> <summary> <para type="description">The eBaseFolder enumeration to get subfolder(s) for the specified root folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.FolderId"> <summary> <para type="description">Identifier of the folder to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.NewFolderName"> <summary> <para type="description">New name of the folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.ReadAccess"> <summary> <para type="description">String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.IshFolder"> <summary> <para type="description">Folder for which to update the metadata. This folder can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder._newFolderName"> <summary> Default value of the new folder name parameter, the API will skip a rename to empty ("") </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.ProcessRecord"> <summary> Process the Set-IshFolder commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.Folder.SetIshFolder.IshFolder"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue"> <summary> <para type="synopsis">The Add-IshLovValue cmdlet adds the new values that are passed through the pipeline or determined via provided parameters to the specified List of Values</para> <para type="description">The Add-IshLovValue cmdlet adds the new values that are passed through the pipeline or determined via provided parameters to the specified List of Values</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue = Add-IshLovValue -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Adding a Value into the List of Values</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.LovId"> <summary> <para type="description">The identifier (element name) of the list of values where the new lov value will be created</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.Label"> <summary> <para type="description">The label of the new lov value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.Description"> <summary> <para type="description">The description of the new lov value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.IshLovValue"> <summary> <para type="description">The lov value to create. This lov value can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.LovValueId"> <summary> <para type="description">The identifier (element name) of the new lov value</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.ProcessRecord"> <summary> Process the Add-IshLovValue commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.AddIshLovValue.IshLovValue"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue"> <summary> <para type="synopsis">The Get-IshLovValue cmdlet retrieves all values of the specified list of values</para> <para type="description">The Get-IshLovValue cmdlet retrieves all values of the specified list of values</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValues = Get-IshLovValue -IshSession $ishSession -LovId DILLUSTRATIONTYPE </code> <para>Retrieve all values from List of Values</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential username $lovValues = Get-IshLovValue -LovId DILLUSTRATIONTYPE -LovValueId ("VRESHIGH","VRESLOW") </code> <para>Retrieve the full LovValues including description and active flag</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue.LovId"> <summary> <para type="description">The element name of the List of Values for which to retrieve values.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue.LovValueId"> <summary> <para type="description">The element name of the value in the List of Values for which to retrieve complete initialized values.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.ListOfValues.GetIshLovValue.ProcessRecord"> <summary> Process the Get-IshLovValue commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshLovValue"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue"> <summary> <para type="synopsis">The Remove-IshLovValue cmd-let removes the values that are passed through the pipeline or determined via provided parameters from the specified List of Values</para> <para type="description">The Remove-IshLovValue cmd-let removes the values that are passed through the pipeline or determined via provided parameters from the specified List of Values</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue = Add-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description" Remove-IshLovValue -IshSession $ishSession -LovId $lovId -LovValueId $lovValue.IshRef </code> <para>Add and remove a value</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue.LovId"> <summary> <para type="description">The element name of the List of Values to delete Value from</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue.LovValueId"> <summary> <para type="description">The element name of the value to remove</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue.IshLovValue"> <summary> <para type="description">LovValue object to remove</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.ListOfValues.RemoveIshLovValue.ProcessRecord"> <summary> Process the Remove-IshLovValue commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue"> <summary> <para type="synopsis">The Set-IshLovValue cmdlet updates the value that is passed through the pipeline or determined via provided parameters in the specified List of Values.</para> <para type="description">The Set-IshLovValue cmdlet updates the value that is passed through the pipeline or determined via provided parameters in the specified List of Values.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue1 = Add-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description" $lovValue2 = Set-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -LovValueId $lovValue1.IshRef -Label "Updated new image type" -Active $true -Description "Updated description" </code> <para>Add and update Value</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.LovId"> <summary> <para type="description">The element name of the List of Values</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.LovValueId"> <summary> <para type="description">The element name of the value to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.Label"> <summary> <para type="description">The Label of the Value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.Description"> <summary> <para type="description">The Description of the Value</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.Active"> <summary> <para type="description">The Active parameter indicates if the value is still active. Making it mandatory since uninitialized boolean is 'false' which will be used in update.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.IshLovValue"> <summary> <para type="description">Lov value to update. This lov value can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.ProcessRecord"> <summary> Process the Set-IshLovValue commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="P:Trisoft.ISHRemote.Cmdlets.ListOfValues.SetIshLovValue.IshLovValue"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat"> <summary> <para type="synopsis">The Add-IshOutputFormat cmdlet adds the new output formats that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshOutputFormat cmdlet adds the new output formats that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "FISHRESOLUTIONS" -Level "none" -Value "Low" | Set-IshMetadataField -IshSession $ishSession -Name "FISHSINGLEFILE" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHCLEANUP" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHKEEPDTDSYSTEMID" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHPUBRESOLVEVARIABLES" -Level "none" -Value "TRUE" -ValueType Element $outputFormat = Add-IshOutputFormat ` -Name "MyOutputFormat" ` -EDT "EDTPDF" ` -Metadata $metadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Adding a new output format</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.Name"> <summary> <para type="description">Name for the new OutputFormat</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.Edt"> <summary> <para type="description">EDT for the new OutputFormat</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.Metadata"> <summary> <para type="description">MetaData - xml structure that will be used for the new OutputFormat</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.IshObject"> <summary> <para type="description">IshObject - contains OutputFormat data that needs to be created. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.OutputFormat.AddIshOutputFormat.ProcessRecord"> <summary> Process the Add-IshOutputFormat commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat"> <summary> <para type="synopsis">The Find-IshOutputFormat cmdlet finds output format objects using ActivityFilter and MetadataFilter that are provided</para> <para type="description">The Find-IshOutputFormat cmdlet finds output format objects using ActivityFilter and MetadataFilter that are provided</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "None" -FilterOperator "Like" -Value "%PDF%" $outputFormats = Find-IshOutputFormat -MetadataFilter $ishMetadataFilterFields </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Find output formats with specific names</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential "username" Find-IshOutputFormat | Select-Object -Property * | Out-GridView </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieves all output formats and make sure that all read-only object properties (PSNoteProperty) become columns in the PowerShell ISE visual GridView.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.OutputFormat.FindIshOutputFormat._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat"> <summary> <para type="synopsis">The Get-IshOutputFormat cmdlet retrieves the metadata of the output formats that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshOutputFormat cmdlet retrieves the metadata of the output formats that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "none" $name = Get-IshOutputFormat -Id "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" -RequestedMetadata $requestedMetadata | Get-IshMetadataField -Name "FISHOUTPUTFORMATNAME" -Level None -ValueType Value </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve name of the existing output format</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.Id"> <summary> <para type="description">Array with the element names of the output formats</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.IshObject"> <summary> <para type="description">Output formats for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.OutputFormat.GetIshOutputFormat.ProcessRecord"> <summary> Process the Get-IshOutputFormat commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.OutputFormat.RemoveIshOutputFormat"> <summary> <para type="synopsis">The Remove-IshOutputFormat cmdlet removes the output formats that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshOutputFormat cmdlet removes the output formats that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "FISHRESOLUTIONS" -Level "none" -Value "Low" | Set-IshMetadataField -IshSession $ishSession -Name "FISHSINGLEFILE" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHCLEANUP" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHKEEPDTDSYSTEMID" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHPUBRESOLVEVARIABLES" -Level "none" -Value "TRUE" -ValueType Element $outputFormatAdd = Add-IshOutputFormat -IshSession $ishSession ` -Name "MyOutputFormat" ` -EDT "EDTPDF" ` -Metadata $metadata Remove-IshOutputFormat -Id $outputFormatAdd[0].IshRef </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Remove added output format</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.RemoveIshOutputFormat.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.RemoveIshOutputFormat.Id"> <summary> <para type="description">The Id - element name of the OutputFormat to be removed</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.RemoveIshOutputFormat.IshObject"> <summary> <para type="description">The IshObject array containing OutputFormats that needs to be deleted. Pipeline</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.OutputFormat.RemoveIshOutputFormat.ProcessRecord"> <summary> Process the Remove-IshOutputFormat commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat"> <summary> <para type="synopsis">The Set-IshOutputFormat cmdlet updates the output formats that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshOutputFormat cmdlet updates the output formats that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "none" -Value "PDF (A4 Manual) updated" $outputFormatUpdate = Set-IshOutputFormat ` -Id "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -Edt "EDTPDF" ` -Metadata $metadataUpdate </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Update name of the existing Output format</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.Id"> <summary> <para type="description">The element name of the output format</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.Edt"> <summary> <para type="description">The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.Metadata"> <summary> <para type="description">The metadata to set for the output format</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.IshObject"> <summary> <para type="description">Output formats for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.OutputFormat.SetIshOutputFormat.ProcessRecord"> <summary> Process the Set-IshOutputFormat commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput"> <summary> <para type="synopsis">The Add-IshPublicationOutput cmdlet add the new publication outputs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshPublicationOutput cmdlet add the new publication outputs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metaDataCreate = Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGDEFAULT' -Level 'lng' -Value 'en' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGIMAGES' -Level 'lng' -Value 'en' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGRESOURCES' -Level 'lng' -Value 'en' Add-IshPublicationOutput -IshSession $ishSession ` -LogicalId "GUID-7EB6F836-A801-4DB3-A54A-22C207BAF671" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en" ` -Metadata $metaDataCreate </code> <para>Creating a new publication output. New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.IshObject"> <summary> <para type="description">The <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/>s that need to be added.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.FolderId"> <summary> <para type="description">The FolderId for the PublicationOutput object.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.IshFolder"> <summary> <para type="description">The FolderId of the PublicationOutput by IshFolder object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.LogicalId"> <summary> <para type="description">The LogicalId of the Publication.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.Version"> <summary> <para type="description">The Version of the Publication.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.OutputFormat"> <summary> <para type="description">The requested OutputFormat for the new PublicationOutput.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.LanguageCombination"> <summary> <para type="description">The requested language combination for the new PublicationOutput.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.Metadata"> <summary> <para type="description">The metadata for the new PublicationOutput.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput._logicalId"> <summary> Logical Id will be defaulted to typical GUID-XYZ in uppercase </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput._version"> <summary> Version will be defaulted to NEW, meaning that a first or next version will be created for existing objects </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput._folderId"> <summary> Holds the folder card id, specified by incoming parameter (long,IShObject) </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.AddIshPublicationOutput.ProcessRecord"> <summary> Process the Add-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput"> <summary> <para type="synopsis">The Find-IshPublicationOutput cmdlet finds all publication outputs using the StatusFilter and MetadataFilter that are provided.</para> <para type="description">The Find-IshPublicationOutput cmdlet finds all publication outputs using the StatusFilter and MetadataFilter that are provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "To Be Published" $publicationOutputs = Find-IshPublicationOutput -StatusFilter "ishnostatusfilter" -MetadataFilter $metadataFilterRetrieve -RequestedMetadata $requestedMetadataRetrieve </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Finding publication outputs</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" $transportPackageZipeFileName = "ish1120329-1-66560-20240123210247030.zip, ish1120329-2-66560-20240123210247030.zip" $metadataFilter = Set-IshMetadataFilterField -Name FISHDITADLVRDEPLOYERIDS -Level Lng -FilterOperator In -Value $transportPackageZipeFileName $publicationOutputs = Find-IshPublicationOutput -MetadataFilter $metadataFilter </code> <para>Transport Package file names are the ZIP files deployed from the CMS into the Deployer service of the Content Delivery stack. When analysis leads to ZIP file names, you can use the above construct to find the actuall PublicatoinOutput that was being published and deployed.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput.StatusFilter"> <summary> <para type="description">The status filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput._statusFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.FindIshPublicationOutput.ProcessRecord"> <summary> Process the Find-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput"> <summary> <para type="synopsis">The Get-IshPublicationOutput cmdlet retrieves the metadata of the publication outputs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshPublicationOutput cmdlet retrieves the metadata of the publication outputs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "Draft" $publicationOutput = Get-IshPublicationOutput ` -LogicalId @("GUID-412E3A98-9AA8-484E-A1AA-3DE3B58947BD", "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9") ` -StatusFilter "ishreleasedordraftstates" ` -RequestedMetadata $requestedMetadataRetrieve ` -MetadataFilter $metadataFilterRetrieve </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieving publication outputs</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadataFilter = Set-IshMetadataFilterField -Level Version -Name VERSION -FilterOperator Equal -Value 14 | Set-IshMetadataFilterField -Level Lng -Name FISHPUBLNGCOMBINATION -FilterOperator Equal -Value "en" | Set-IshMetadataFilterField -Level Lng -Name FISHOUTPUTFORMATREF -FilterOperator Equal -ValueType Element -Value VOUTPUTFORMATDITADELIVERY # see Find-IshOutputFormat Id column $publicationOutput = Get-IshPublicationOutput -LogicalId @("GUID-03081B9A-11E4-4862-845B-27339E0C400D", "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9") -MetadataFilter $metadataFilter </code> <para>Retrieve specific ParameterGroup identified IshObjects, similar to what Publish-IshPublicationOutput would push to the pipeline for usage downstream on Get-IshPublicationOutputData.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.LogicalId"> <summary> <para type="description">The LogicalId of the publication output objects.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.IshObject"> <summary> <para type="description">Array with the publication outputs for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.StatusFilter"> <summary> <para type="description">The status filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput._statusFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutput.ProcessRecord"> <summary> Process the Get-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputData"> <summary> <para type="synopsis">The Get-IshPublicationOutputData cmdlet retrieves the data/blob of the publication output that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder.</para> <para type="description">The Get-IshPublicationOutputData cmdlet retrieves the data/blob of the publication output that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "Draft" $publicationOutputs = Find-IshPublicationOutput -IshSession $ishSession -StatusFilter "ishnostatusfilter" -MetadataFilter $metadataFilterRetrieve -RequestedMetadata $requestedMetadataRetrieve $fileInfoArray = $publicationOutputs | Get-IshPublicationOutputData -FolderPath "c:\temp\export" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Downloading publication outputs</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputData.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputData.IshObject"> <summary> <para type="description">Array with the publication outputs for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputData.FolderPath"> <summary> <para type="description">Folder on the Windows filesystem where to store the retrieved data files</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputData.ProcessRecord"> <summary> Process the Get-IshPublicationOutputData commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:System.IO.File"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputFolderLocation"> <summary> <para type="synopsis">The Get-IshPublicationOutputFolderLocation cmdlet returns the repository location of the publication output in the form of a separated string e.g. "General\Folder1\Folder2"</para> <para type="description">The Get-IshPublicationOutputFolderLocation cmdlet returns the repository location of the publication output in the form of a separated string e.g. "General\Folder1\Folder2"</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderLocation = Get-IshPublicationOutputFolderLocation -LogicalId "GUID-412E3A98-9AA8-484E-A1AA-3DE3B58947BD" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve location of the PublicationOutput</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputFolderLocation.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputFolderLocation.LogicalId"> <summary> <para type="description">The LogicalId of the PublicationOutput object</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputFolderLocation.IshObject"> <summary> <para type="description">Publication output for which to retrieve the content data. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.GetIshPublicationOutputFolderLocation.ProcessRecord"> <summary> Process the Get-IshPublicationOutputFolderLocation commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublicationOutputCmdlet"> <summary> Abstract class used for the publication output commandlets. </summary> <remarks>Inherits from <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/>.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput"> <summary> <para type="synopsis">The Publish-IshPublicationOutput cmdlet publishes all publication outputs that are passed through the pipeline or determined via provided parameters.</para> <para type="description">The Publish-IshPublicationOutput cmdlet publishes all publication outputs that are passed through the pipeline or determined via provided parameters.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishobjects = Publish-IshPublicationOutput ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Publishing a publication output</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.IshObject"> <summary> <para type="description">Array with the publications outputs to publish. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.LogicalId"> <summary> <para type="description">The logical identifier of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.Version"> <summary> <para type="description">The version of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.OutputFormat"> <summary> <para type="description">The output format (GUID) of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.LanguageCombination"> <summary> <para type="description">The language combination of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository</para> <para type="description">If the metadata is still the same, the publication output is published.</para> <para type="description">If the metadata is not the same anymore, an error is given and the publication output is not published.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.PublishIshPublicationOutput.ProcessRecord"> <summary> Process the Publish-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput"> <summary> <para type="synopsis">The Remove-IshPublicationOutput cmdlet removes the publication outputs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshPublicationOutput cmdlet removes the publication outputs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" # Remove publication output Remove-IshPublicationOutput ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "PDF (A4 Manual)" ` -LanguageCombination "en" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Removing a publication output</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.IshObject"> <summary> <para type="description">Array with the publication outputs to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.LogicalId"> <summary> <para type="description">The LogicalId of the publication output</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.Version"> <summary> <para type="description">The version of the publication output</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.OutputFormat"> <summary> <para type="description">The output format of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.LanguageCombination"> <summary> <para type="description">The language combination of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the publication output is removed.</para> <para type="description">If the metadata is not the same anymore, an error is given and the publication output is not removed.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.Force"> <summary> <para type="description">When the Force switch is set, after deleting the publication output object, the publication version object and publication logical object will be deleted if they don't have any publication outputs anymore. Be carefull using this option, as it will delete the publication (version) and baseline if there are no outputformats left!!</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.RemoveIshPublicationOutput.ProcessRecord"> <summary> Process the Remove-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput"> <summary> <para type="synopsis">The Set-IshPublicationOutput cmdlet updates the publication outputs that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshPublicationOutput cmdlet updates the publication outputs that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" # Update a publication output $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name FISHFALLBACKLNGDEFAULT -Level lng -Value 'bg' | Set-IshMetadataField -IshSession $ishSession -Name FISHFALLBACKLNGIMAGES -Level lng -Value 'bg' | Set-IshMetadataField -IshSession $ishSession -Name FISHFALLBACKLNGRESOURCES -Level lng -Value 'bg' Set-IshPublicationOutput -IshSession $ishSession -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" -Version "1" -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" -LanguageCombination "en" -MetaData $metadataUpdate </code> <para>Updating publication outputs publish fallback parameters</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" # Find all publication pending objects and cancel their publish operation $ishObjects = Find-IshPublicationOutput -IshSession $ishSession -StatusFilter ISHNoStatusFilter -MetadataFilter(Set-IshMetadataFilterField -IshSession $ishSession -Name FISHPUBSTATUS -Level Lng -ValueType Element -FilterOperator in -Value VPUBSTATUSPUBLISHPENDING) $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name FISHPUBSTATUS -Level lng -ValueType Element -Value VPUBSTATUSPUBLISHINGCANCELLED $ishObjects | Set-IshPublicationOutput -MetaData $metadataUpdate </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Cancelling all publication outputs publish operations without checking if the status transition is allowed</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.IshObject"> <summary> <para type="description">Publication outputs for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.LogicalId"> <summary> <para type="description">The LogicalId of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.Version"> <summary> <para type="description">The version of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.OutputFormat"> <summary> <para type="description">The output format of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.LanguageCombination"> <summary> <para type="description">The language combination of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.Metadata"> <summary> <para type="description">The metadata to set for the publication output object.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the metadata will be set.</para> <para type="description">If the metadata is not the same anymore, an error is given and the metadata will be set.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.SetIshPublicationOutput.ProcessRecord"> <summary> Process the Set-IshPublicationOutput commandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput"> <summary> <para type="synopsis">The Stop-IshPublicationOutputcmdlet cancels publishes of all publication outputs that are passed through the pipeline or determined via provided parameters.</para> <para type="description">The Stop-IshPublicationOutputcmdlet cancels publishes of all publication outputs that are passed through the pipeline or determined via provided parameters.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishobjects = Stop-IshPublicationOutput-IshSession $ishSession ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en" </code> <para>Cancelling publish of a publication output</para> </example> <example> <code> function Add-Properties { param ($ishObject) [xml]$metadataXml = $ishObject.IshFields.ToXml() foreach($field in $metadataXml.SelectNodes("/ishfields/ishfield")) { $ishObject = $ishObject | Add-Member -MemberType NoteProperty -Name $field.GetAttribute("name") -Value ($field.InnerText) -PassThru -Force } Write-Output $ishObject } $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level Version | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FTITLE' -Level Logical $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level Lng -ValueType Element -FilterOperator In -Value "VPUBSTATUSPUBLISHINGCANCELLED, VPUBSTATUSPUBLISHPENDING, VPUBSTATUSPUBLISHING" # VPUBSTATUSTOBEPUBLISHED $ishObjects = Find-IshPublicationOutput -IshSession $ishSession -MetadataFilter $metadataFilter -RequestedMetadata $requestedMetadata $ishObjectsToCancel = $ishObjects | ForEach-Object { Add-Properties $_ } | Select-Object -Property FTITLE,IshRef,VERSION,FISHPUBLNGCOMBINATION,FISHOUTPUTFORMATREF,FISHPUBLISHER,FISHPUBSTATUS,FISHPUBSTARTDATE,FISHPUBENDDATE | Out-GridView -OutputMode Multiple -Title "Select one or more entries to Cancel publishing on" </code> <para>Finding all publications that are currently in progress. For now auxiliary function Add-Properties promotes ishfields in a simple way to become NoteProperties on the root ishobject.</para> <para>Passing them in PowerShell ISE to Out-GridView for pipeline handling downstream. New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.IshObject"> <summary> <para type="description">Array with the publication outputs to cancel. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.LogicalId"> <summary> <para type="description">The logical identifier of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.Version"> <summary> <para type="description">The version of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.OutputFormat"> <summary> <para type="description">The output format (GUID) of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.LanguageCombination"> <summary> <para type="description">The language combination of the publication output.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository. If the metadata is still the same, the publication output is cancelled. If the metadata is not the same anymore, an error is given and the publication output is not cancelled.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.PublicationOutput.StopIshPublicationOutput.ProcessRecord"> <summary> Process the Stop-IshPublicationOutputcommandlet. </summary> <exception cref="T:Trisoft.ISHRemote.Exceptions.TrisoftAutomationException"></exception> <exception cref="T:System.Exception"></exception> <remarks>Writes an <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array to the pipeline.</remarks> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession"> <summary> <para type="synopsis">The New-IshSession cmdlet creates a new IshSession object using the parameters that are provided.</para> <para type="description">The communication protocol will be derived from the server-side product version. On 14SP4/14.0.4 plus ISHRemote 7.0 and earlier there is only WcfSoapWithWsTrust. Since 15/15.0.0 ISHRemote prefers Modern Authentication and selects WcfSoapWithOpenIdConnect. Experimental since 15/15.0.0 is OpenApiWithOpenIdConnect, where already possible cmdlets will go over OpenAPI REST calls instead of WcfSoapWithOpenIdConnect calls.</para> <para type="description">The New-IshSession cmdlet creates a new IshSession object for usage on any other cmdlet later using the parameters that are provided.</para> <para type="description">The object contains the service endpoint proxies, and api contract information like multi-value separator, date format, etc</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "admin" -IshPassword "admin" </code> <para>Building a session for the chosen service based on username/password authentication provided by the CMS as Identity Provider.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" </code> <para>Building a session for the chosen service based on implicit authentication.</para> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems. An implicit NetworkCredential object will be passed for authentication to the service on PowerShell 5.1 - will throw an error on PowerShell 7.2+.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. This will trigger the interactive system browser based flow - so your browser as trusted single sign on client.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "" -IshPassword "admin" </code> <para>Building a session for the chosen service based on Active Directory authentication. By providing an empty username (and ignoring the password), an implicit NetworkCredential object will be passed for authentication to the service. This makes it possible to write generic scripts for UserNameMixed/ActiveDirectory authentication.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" </code> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems. Iteratively the New-IshSession line with PSCredential parameter holding a string representation will prompt you for a password.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Iteratively the New-IshSession line with PSCredential parameter holding a string representation will prompt you for a ClientSecret. Note that sample 'Admin' as ClientId has to be configured in Access Management (ISHAM), by default ClientId typically is a GUID.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "admin" -IshPassword "admin" -Timeout (New-TimeSpan -Seconds 30) </code> <para>Building a session for the chosen service based on username/password authentication provided by the CMS as Identity Provider. The Timeout parameter, expressed as TimeSpan object, controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> $securePassword = ConvertTo-SecureString "MYPASSWORD" -AsPlainText -Force $mycredentials = New-Object System.Management.Automation.PSCredential("MYISHUSERNAME", $securePassword) New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential $mycredentials </code> <para>Extensive automation example based on the PSCredential parameter. Responsibility of the plain text password or client secret is yours. Check Microsoft module https://devblogs.microsoft.com/powershell/secretmanagement-and-secretstore-are-generally-available/</para> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Note that sample 'MYISHUSERNAME' as ClientId has to be configured in Access Management (ISHAM), by default ClientId typically is a GUID.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -ClientId "c826e7e1-c35c-43fe-9756-e1b61f44bb40" -ClientSecret "ziKiGbx6N0G3m69/vWMZUTs2paVO1Mzqt6Y6TX7mnpPJyFVODsI1Vw==" </code> <para>Building a session for the chosen service based on Client Credentials authentication.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Note that ClientId/ClientSecret has to be configured in Access Management (ISHAM), by default ClientId typically is a GUID.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -ClientId "c826e7e1-c35c-43fe-9756-e1b61f44bb40" -ClientSecret "ziKiGbx6N0G3m69/vWMZUTs2paVO1Mzqt6Y6TX7mnpPJyFVODsI1Vw==" -Protocol OpenApiWithOpenIdConnect </code> <para>Building a session for the chosen service based on Client Credentials authentication.</para> <para>Explicit Protocol OpenApiWithOpenIdConnect on 15/15.0.0 and later systems will initialize the OpenApi endpoints giving you access to the $ishSession.OpenApiISH30Service proxy.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.WsBaseUrl"> <summary> <para type="description">Tridion Docs Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.PSCredential"> <summary> <para type="description">Standard PowerShell Credential class</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.IshUserName"> <summary> <para type="description">Username to login into Tridion Docs Content Manager. When left empty, fall back to ActiveDirectory.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.IshPassword"> <summary> <para type="description">Password to login into Tridion Docs Content Manager</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.ClientId"> <summary> <para type="description">Client ID when Protocol OpenApiWithOpenIdConnect or WcfSoapWithOpenIdConnect is used to trigger OAuth2/OpenIDConnect Client Credential Flow for usage to Issuer's /connect/token endpoint.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.ClientSecret"> <summary> <para type="description">Client Secret when Protocol OpenApiWithOpenIdConnect or WcfSoapWithOpenIdConnect is used to trigger OAuth2/OpenIDConnect Client Credential Flow for usage to Issuer's /connect/token endpoint.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.Timeout"> <summary> <para type="description">Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 30 minutes.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.IgnoreSslPolicyErrors"> <summary> <para type="description">IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.Protocol"> <summary> <para type="description">IshSession Protocol explicitly selects the communication protocol; either WcfSoapWithWsTrust (legacy option of Tridion Docs 14SP4/14.0.4, in turn ISHRemote 7.0 and earlier), WcfSoapWithOpenIdConnect (since Tridion Docs 15/15.0.0) and OpenApiWithOpenIdConnect (experimental since Tridion Docs 15/15.0.0). If not provided, the CMS version will pick the most optimal support protocol. See also <see cref="P:Trisoft.ISHRemote.Cmdlets.Session.NewIshSession.Protocol"/>.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Session.SessionCmdlet"> <summary> Abstract class used for the session commandlets. </summary> <remarks>Inherits from <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/>.</remarks> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Session.SessionCmdlet.BeginProcessing"> <summary> Solves the PS51/NET48 problem of OidcClient which continuously threw 'Error connecting to https://sts.windows.net/{tenant}/.well-known/openid-configuration. Operation is not valid due to the current state of the object' in GetDiscoveryDocumentAsync as described on https://github.com/IdentityModel/Documentation/issues/13 <see cref="T:Trisoft.ISHRemote.HelperClasses.AppDomainModuleAssemblyInitializer"/> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession"> <summary> <para type="synopsis">The Test-IshSession cmdlet creates a new IshSession object using the parameters that are provided.</para> <para type="description">The communication protocol will be derived from the server-side product version (AutoDetect). On 14SP4/14.0.4 plus ISHRemote 7.0 and earlier the default is WcfSoapWithWsTrust. Since 15/15.0.0 ISHRemote prefers Modern Authentication and selects WcfSoapWithOpenIdConnect. Experimental since 15/15.0.0 is OpenApiWithOpenIdConnect, where already possible cmdlets will go over OpenAPI REST calls instead of WcfSoapWithOpenIdConnect calls.</para> <para type="description">The Test-IshSession cmdlet internal creates a minimal IshSession object using the parameters that are provided.</para> <para type="description">Tests the WebServices (ISHWS-activation) and validates the credentials in the 'InfoShare' database (ConnectionString-activation).</para> </summary> <example> <code> Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "admin" -IshPassword "admin" </code> <para>Building a session for the chosen service based on username/password authentication provided by the CMS as Identity Provider.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" </code> <para>Building a session for the chosen service.</para> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems. An implicit NetworkCredential object will be passed for authentication to the service on PowerShell 5.1 - will throw an error on PowerShell 7.2+.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. This will trigger the interactive system browser based flow - so your browser as trusted single sign on client.</para> </example> <example> <code> Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "" -IshPassword "admin" </code> <para>Building a session for the chosen service based on Active Directory authentication. By providing an empty username (and ignoring the password), an implicit NetworkCredential object will be passed for authentication to the service. This makes it possible to write generic scripts for UserNameMixed/ActiveDirectory authentication.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" </code> <para>Iteratively the Test-IshSession line with PSCredential parameter holding a string representation will prompt you for a password.</para> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Note that ClientId 'Admin' has to be configured in Access Management (ISHAM), by default ClientId typically is a GUID.</para> </example> <example> <code> Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "admin" -IshPassword "admin" -Timeout (New-TimeSpan -Seconds 30) </code> <para>Building a session for the chosen service based on username/password authentication provided by the CMS as Identity Provider. The Timeout parameter, expressed as TimeSpan object, controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml.</para> <para>Protocol will be WcfSoapWithWsTrust because of parameters -IshUserName/-IshPassword.</para> </example> <example> <code> $securePassword = ConvertTo-SecureString "MYPASSWORD" -AsPlainText -Force $mycredentials = New-Object System.Management.Automation.PSCredential("MYISHUSERNAME", $securePassword) Test-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential $mycredentials </code> <para>Extensive automation example based on the PSCredential parameter. Responsibility of the plain text password or client secret is yours.</para> <para>Protocol will be WcfSoapWithWsTrust on 14SP4/14.0.4 and earlier systems.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Note that 'Admin' has to be you ClientId as configured in Access Management (ISHAM), by default this typically is a GUID.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -ClientId "c826e7e1-c35c-43fe-9756-e1b61f44bb40" -ClientSecret "ziKiGbx6N0G3m69/vWMZUTs2paVO1Mzqt6Y6TX7mnpPJyFVODsI1Vw==" </code> <para>Building a session for the chosen service based on username/password authentication. Parameter Protocol indicates the preferred communication/authentication route.</para> <para>Protocol will be WcfSoapWithOpenIdConnect on 15/15.0.0 and later systems. Note that ClientId/ClientSecret has to be configured in Access Management (ISHAM), by default ClientId typically is a GUID.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.WsBaseUrl"> <summary> <para type="description">Tridion Docs Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.PSCredential"> <summary> <para type="description">Standard PowerShell Credential class</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.IshUserName"> <summary> <para type="description">Username to login into Tridion Docs Content Manager. When left empty, fall back to ActiveDirectory.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.IshPassword"> <summary> <para type="description">Password to login into Tridion Docs Content Manager</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.ClientId"> <summary> <para type="description">Client ID when Protocol OpenApiWithOpenIdConnect or WcfSoapWithOpenIdConnect is used to trigger OAuth2/OpenIDConnect Client Credential Flow for usage to Issuer's /connect/token endpoint.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.ClientSecret"> <summary> <para type="description">Client Secret when Protocol OpenApiWithOpenIdConnect or WcfSoapWithOpenIdConnect is used to trigger OAuth2/OpenIDConnect Client Credential Flow for usage to Issuer's /connect/token endpoint.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.Timeout"> <summary> <para type="description">Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 30 minutes.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.IgnoreSslPolicyErrors"> <summary> <para type="description">IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.Protocol"> <summary> <para type="description">IshSession Protocol tries to connect the communication protocol like WcfSoapWithWsTrust (legacy option of Tridion Docs 14SP4/14.0.4 and ISHRemote 7.0 and earlier), WcfSoapWithOpenIdConnect (since Tridion Docs 15/15.0.0) and OpenApiWithOpenIdConnect (experimental since Tridion Docs 15/15.0.0). If not provided or default value AutoDetect will pick the most optimal support protocol. See also <see cref="P:Trisoft.ISHRemote.Cmdlets.Session.TestIshSession.Protocol"/>.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition"> <summary> <para type="synopsis">This cmdlet compares two IshTypeFieldDefinition sets.</para> <para type="description">This cmdlet compares two IshTypeFieldDefinition sets allowing system compares (or even a compare with the deprecated TriDKXmlSetup format). The result is an IshTypeFieldDefinition with a Compare property indicating equal, different, left only or right only. Note that fields FDESCRIPTION and FCHANGES can have either type String or LongText, you can consider this false positives - this will only affect field filter operators.</para> </summary> <example> <code> $ishSessionA = New-IshSession -WsBaseUrl "https://example.com/ISHWSPROD/" -PSCredential "Admin" $ishSessionB = New-IshSession -WsBaseUrl "https://example.com/ISHWSTEST/" -PSCredential "Admin" Compare-IshTypeFieldDefinition -LeftIshSession $ishSessionA -RightIshSession $ishSessionB </code> <para>Compares incoming IshSession entries that are not equal, so indicating differences, left only and right only.</para> </example> <example> <code> $ishSessionA = New-IshSession -WsBaseUrl "https://example.com/ISHWSPROD/" -PSCredential "Admin" $ishSessionB = New-IshSession -WsBaseUrl "https://example.com/ISHWSTEST/" -PSCredential "Admin" Compare-IshTypeFieldDefinition -LeftIshSession $ishSessionA -RightIshSession $ishSessionB -ExcludeLeftUnique </code> <para>Compares incoming IshSession entries that are not equal, so indicating differences and right only changes compared to the $ishSessionA reference.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWSPROD/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition -TriDKXmlSetupFilePath $tempFilePath Compare-IshTypeFieldDefinition -LeftIshTypeFieldDefinition $ishTypeFieldDefinitions -RightIshSession $ishSession -ExcludeLeftUnique </code> <para>Compares provided reference TriDKXmlSetup export file with incoming IshSession and that lists differences and right only changes.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWSPROD/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition Compare-IshTypeFieldDefinition -LeftIshSession $ishSession -RightIshTypeFieldDefinition $ishTypeFieldDefinitions -IncludeIdentical -ExcludeDifferent </code> <para>Compares incoming IshSession and IshTypeFieldDefinitions (TriDKXmlSetup export file made available through Resource entry). The IncludeIdentical flag will also return matching rows, while the ExcludeDifferent flag will not return rows with differences.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWSPROD/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition Compare-IshTypeFieldDefinition -LeftIshTypeFieldDefinition $ishTypeFieldDefinitions -RightIshSession $ishSession -IncludeIdentical | Where-Object -Property Name -NotLike "FTEST*" | Out-GridView </code> <para>Compares reference IshTypeFieldDefinitions (TriDKXmlSetup export file made available through Resource entry) with incoming IshSession. The IncludeIdentical flag will also return matching rows, while the Where-Object clause filters out fields with a certain name. The PowerShell Out-GridView does a nice visual rendering in PowerShell ISE.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.LeftIshSession"> <summary> <para type="description">The reference object of type IshSession</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.LeftIshTypeFieldDefinition"> <summary> <para type="description">The reference object of type IshTypeFieldDefinition array</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.RightIshSession"> <summary> <para type="description">The difference object of type IshSession</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.RightIshTypeFieldDefinition"> <summary> <para type="description">The difference object of type IshTypeFieldDefinition array</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.IncludeIdentical"> <summary> <para type="description">Display characteristics of compared objects that are equal. By default, only characteristics that differ between the left and right objects are displayed.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.ExcludeDifferent"> <summary> <para type="description">Stop displaying characteristics of compared objects that are different.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.ExcludeLeftUnique"> <summary> <para type="description">Stop displaying characteristics of compared objects that are unique in the left reference object.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.CompareIshTypeFieldDefinition.ExcludeRightUnique"> <summary> <para type="description">Stop displaying characteristics of compared objects that are unique in the right difference object.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting"> <summary> <para type="synopsis">This cmdlet can be used to get a configuration setting from the repository. Depending on the parameters you use, the setting will be returned differently. If you provide: * A requested metadata parameter with the fields to get, the setting will be return as IshFields * A fieldname and no filepath, the setting will be returned as string * A fieldname and a filepath, the setting will be saved to the file. If the file is already present, providing -Force will allow you to overwrite the file</para> <para type="description">This cmdlet can be used to get a configuration setting from the repository. Depending on the parameters you use, the setting will be returned differently. If you provide: * A requested metadata parameter with the fields to get, the setting will be return as IshFields * A fieldname and no filepath, the setting will be returned as string * A fieldname and a filepath, the setting will be saved to the file. If the file is already present, providing -Force will allow you to overwrite the file</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $settingsFolderPath = 'C:\temp' Write-Verbose "Saving in $settingsFolderPath" $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLInboxConfiguration.xml" Get-IshSetting -FieldName "FINBOXCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLBackgroundTaskConfiguration.xml" Get-IshSetting -FieldName "FISHBACKGROUNDTASKCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLChangeTrackerConfig.xml" Get-IshSetting -FieldName "FISHCHANGETRACKERCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLExtensionConfiguration.xml" Get-IshSetting -FieldName "FISHEXTENSIONCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLPluginConfig.xml" Get-IshSetting -FieldName "FISHPLUGINCONFIGXML" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLStatusConfiguration.xml" Get-IshSetting -FieldName "FSTATECONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLTranslationConfiguration.xml" Get-IshSetting -FieldName "FTRANSLATIONCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLWriteObjPluginConfig.xml" Get-IshSetting -FieldName "FISHWRITEOBJPLUGINCFG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLPublishPluginConfiguration.xml" Get-IshSetting -FieldName "FISHPUBLISHPLUGINCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLCollectiveSpacesConfiguration.xml" Get-IshSetting -FieldName "FISHCOLLECTIVESPACESCFG" -FilePath $filePath Write-Host "Done, see $settingsFolderPath" </code> <para>Retrieve all Settings xml configuration entries and save them in a folder to desk allowing file-to-file comparison with EnterViaUI folder.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.FieldName"> <summary> <para type="description">The settings field to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.FilePath"> <summary> <para type="description">File on the Windows filesystem where to save the retrieved setting</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting.Force"> <summary> <para type="description">When set, will override the file when it already exists</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Settings.GetIshSetting._valueType"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTimeZone"> <summary> <para type="synopsis">This cmdlet returns the time zone information of the web/app server. This cmdlet can also be used to measure the latency between the client and the server.</para> <para type="description">This cmdlet returns the time zone information of the web/app server. This cmdlet can also be used to measure the latency between the client and the server. ClientElapsed - either Min, Average or Max - indicates the time taken to execute the web service call measured from the client. AppServerElapsed - either Min, Average or Max - indicates the time taken to execute the database query measured on the web/app server. DbServerElapsed - either Min, Average or Max - indicates the time taken to execute the database query measured on the database server. By performing multiple calls using the Count parameter you will get a better idea on variation on the calls. Client and app server network latency is calculated through: ClientElapsed - AppServerElapsed. App server and db server network latency is calculated through: AppServerElapsed - DbServerElapsed.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshTimeZone -IshSession $ishSession </code> <para>Creates an IshApplicationSetting structure some timings but especially holds the TimeZoneInfo of the targeted application server.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshTimeZone -IshSession $ishSession -Count 2 </code> <para>Creates an IshApplicationSettings structure holds the TimeZoneInfo of the targeted application server. But especially holds time difference between client requests, application-server requests and database-server requests.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTimeZone.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTimeZone.Count"> <summary> <para type="description">The amount off get timezone webservice call you wish to perform.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTypeFieldDefinition"> <summary> <para type="synopsis">This cmdlet retuns the system Type and Field definitions as IshTypeFieldDefinition objects.</para> <para type="description">This cmdlet will use Settings25.RetrieveFieldSetupByIshType when available. It can be used to load the deprecated TriDKXmlSetup format into IshTypeFieldDefinition objects.</para> </summary> <example> <code> Get-IshTypeFieldDefinition | Where-Object -Property ISHType -eq "ISHUser" </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet.</para> <para>If no IshSession set, the latest internal resource string will be loaded (based on Full-Export). The Where-Object allows filtering on chosen properties.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshTypeFieldDefinition -IshSession $ishSession </code> <para>When ServerVersion -ge 13.0.0 the definition of your targeted IshSession is retrieved, otherwise the best matching internal resource string will be loaded (based on Full-Export).</para> </example> <example> <code> Get-IshTypeFieldDefinition -IshSession $ishSession | Where-Object -Property ISHType -eq ISHUser | Where-Object -Property AllowOnCreate -eq $true | Where-Object -Property IsMandatory -eq $true </code> <para>What are the fields I should pass when creating a new user through Add-IshUser.</para> </example> <example> <code> Get-IshTypeFieldDefinition -IshSession $ishSession | Out-GridView </code> <para>When using PowerShell ISE, you can list the result in a User Interface that even allows selection (through -OutputMode Multiple). The standard PowerShell grid view as extra filters and column sorting functionality.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTypeFieldDefinition.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTypeFieldDefinition.TriDKXmlSetupFilePath"> <summary> <para type="description">File on the Windows filesystem where to load the TriDKXmlSetup full export from</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.Settings.GetIshTypeFieldDefinition.ProcessRecord"> <summary> <para type="description">File on the Windows filesystem where to load the DBUT full export from. Where DBUT is the successor of TriDKXmlSetup.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting"> <summary> <para type="synopsis">This cmdlet can be used to set a configuration setting in the repository. Depending on the parameters you use, the value to set is read from different inputs. If you provide: * A metadata parameter with the fields to set, all fields and values will be read from the IshFields and set * A fieldname and a value, the value will be set for the given field * A fieldname and a filepath, the value will be read from the file and set for the given field</para> <para type="description">This cmdlet can be used to set a configuration setting in the repository. Depending on the parameters you use, the value to set is read from different inputs. If you provide: * A metadata parameter with the fields to set, all fields and values will be read from the IshFields and set * A fieldname and a value, the value will be set for the given field * A fieldname and a filepath, the value will be read from the file and set for the given field</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin" $settingsFolderPath = 'C:\temp' Write-Verbose "Submitting Xml Settings from $settingsFolderPath" $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLInboxConfiguration.xml" Set-IshSetting -FieldName "FINBOXCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLBackgroundTaskConfiguration.xml" Set-IshSetting -FieldName "FISHBACKGROUNDTASKCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLChangeTrackerConfig.xml" Set-IshSetting -FieldName "FISHCHANGETRACKERCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLExtensionConfiguration.xml" Set-IshSetting -FieldName "FISHEXTENSIONCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLPluginConfig.xml" Set-IshSetting -FieldName "FISHPLUGINCONFIGXML" -FilePath $filePath # Version 13.0.0 requires a status to be present before status transitions can be confirmed # Add-IshLovValue -LovId DSTATUS -Label "Translation In Review" -Description "Translation In Review" $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLStatusConfiguration.xml" Set-IshSetting -FieldName "FSTATECONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLTranslationConfiguration.xml" Set-IshSetting -FieldName "FTRANSLATIONCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLWriteObjPluginConfig.xml" Set-IshSetting -FieldName "FISHWRITEOBJPLUGINCFG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLPublishPluginConfiguration.xml" Set-IshSetting -FieldName "FISHPUBLISHPLUGINCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLCollectiveSpacesConfiguration.xml" Set-IshSetting -FieldName "FISHCOLLECTIVESPACESCFG" -FilePath $filePath Write-Host "Done" </code> <para>Submit all Xml Settings configuration entries from your prepared folder (or standard EnterViaUI folder).</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshSetting -FieldName FISHLCURI -Value https://something/deleteThis </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Update CTCONFIGURATION field with the presented value.</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshSetting -FieldName FISHLCURI </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Update CTCONFIGURATION field with the value empty string ("").</para> </example> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $originalValue = Get-IshSetting -FieldName FISHENABLEOUTOFDATE -ValueType Element Set-IshSetting -FieldName FISHENABLEOUTOFDATE -ValueType Element -Value $true Set-IshSetting -FieldName FISHENABLEOUTOFDATE -ValueType Element -Value $originalValue </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Update CTCONFIGURATION field with the value empty string ("").</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.Metadata"> <summary> <para type="description">The metadata with the fields and values to set</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.FieldName"> <summary> <para type="description">The settings field to set</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.Value"> <summary> <para type="description">The value to set</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.ValueType"> <summary> <para type="description">The value type</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.FilePath"> <summary> <para type="description">File on the Windows filesystem where to read the setting from</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting.RequiredCurrentMetadata"> <summary> <para type="description">The required current metadata of the setting. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</para> <para type="description">If the metadata is still the same, the metadata will be set.</para> <para type="description">If the metadata is not the same anymore, an error is given and the metadata will be set.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.Settings.SetIshSetting._valueType"> <summary> Private fields to store the parameters and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"> <summary> Which verb to use: check http://msdn.microsoft.com/en-us/library/ms714428(v=vs.85).aspx How to trace the pipelin: http://www.eggheadcafe.com/software/aspnet/31521302/valuefrompipelinebypropertyname.aspx External MAML help: http://cmille19.wordpress.com/2009/09/24/external-maml-help-files/ and: http://technet.microsoft.com/en-us/library/dd819489.aspx Progress Record: http://community.bartdesmet.net/blogs/bart/archive/2006/11/26/PowerShell-_2D00_-A-cmdlet-that-reports-progress-_2D00_-A-simple-file-downloader-cmdlet.aspx </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.SleepTime"> <summary> Sleep constant used to slow down the progress bars to check the messages. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.ISHRemoteSessionStateIshSession"> <summary> Name of the PSVariable so you don't have to specify '-IshSession $ishSession' anymore, should be set by New-IshSession </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.ISHRemoteSessionStateIshSessionException"> <summary> Error message you get when you didn't pass an explicit -IshSession on the cmdlet, or New-IshSession didn't set the SessionState variable </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.WriteParentProgress(System.String,System.Int32,System.Int32)"> <summary> Write progress over the complete cmdlet, so over updates and retrieves </summary> <param name="message">What are you processing</param> <param name="current">Current step number</param> <param name="total">Total number of steps</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.WriteChildProgress(System.String,System.Int32,System.Int32)"> <summary> Write progress over the specific (webservice) calls required to process a list of ids/ishobjects </summary> <param name="message">What are you processing</param> <param name="current">Current step number</param> <param name="total">Total number of steps</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.WriteVerbose(System.String)"> <summary> Intentional override to include cmdlet origin </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.WriteDebug(System.String)"> <summary> Intentional override to include cmdlet origin and timestamp </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.WriteWarning(System.String)"> <summary> Intentional override to include cmdlet origin </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.BaseFolderLabelToEnum(Trisoft.ISHRemote.Objects.Public.IshSession,System.String)"> <summary> Convert base folder label into a BaseFolder enumeration value </summary> <param name="ishSession">The <see cref="T:Trisoft.ISHRemote.Objects.Public.IshSession"/>.</param> <param name="baseFolderLabel">Label of the base folder</param> <returns>The BaseFolder enumeration value</returns> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.BaseFolderEnumToLabel(Trisoft.ISHRemote.Objects.Public.IshSession,Trisoft.ISHRemote.Folder25ServiceReference.BaseFolder)"> <summary> Convert a BaseFolder enumeration value into a base folder label </summary> <param name="ishSession">Client session object to the InfoShare server instance. Keeps track of your security tokens and provide you clients to the various API end points. Holds matching contract parameters like separators, batch and chunk sizes.</param> <param name="baseFolder">BaseFolder enumeration value</param> <returns>base folder label</returns> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet.DivideListInBatches``1(System.Collections.Generic.List{``0},System.Int32)"> <summary> Divides one list to multiple lists by batchsize </summary> <typeparam name="T">Type</typeparam> <param name="list">List to devide</param> <param name="batchSize"></param> <returns>Multiple lists, all having maximally batchsize elements</returns> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger"> <summary> Singleton proxy for single instance of <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/> class that provides logging functionality. </summary> <seealso cref="T:Trisoft.ISHRemote.Interfaces.ILogger" /> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger._instance"> <summary> The static instance of the <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger"/> class. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger._cmdlet"> <summary> The instance of the <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/> class. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.ProgressActivityId"> <summary> The progress activity identifier. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.ParentProgressActivityId"> <summary> The parent progress activity identifier. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger._progressRecord"> <summary> The progress record. </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger._parentProgressRecord"> <summary> The parent progress record. </summary> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.Instance"> <summary> Gets the instance of the <see cref="T:Trisoft.ISHRemote.Interfaces.ILogger"/> instance. </summary> <returns>Instance of the <see cref="T:Trisoft.ISHRemote.Interfaces.ILogger"/> interface.</returns> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.Initialize(Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet)"> <summary> Initializes the the instance of the <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger"/> with instance of <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/> class. </summary> <param name="cmdlet">The instance of the <see cref="T:Trisoft.ISHRemote.Cmdlets.TrisoftCmdlet"/> class.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteProgress(System.String,System.String,System.Int32)"> <summary> Reports progress. </summary> <param name="activity">Activity that takes place.</param> <param name="statusDescription">Current status description.</param> <param name="percentComplete">Complete progress in percent equivalent.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteParentProgress(System.String,System.String,System.Int32)"> <summary> Reports progress for parent progress bar. </summary> <param name="activity">Activity that takes place.</param> <param name="statusDescription">Status description.</param> <param name="percentComplete">Complete progress in percent equivalent.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteVerbose(System.String)"> <summary> Writes verbose message. </summary> <param name="message">Verbose message.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteDebug(System.String)"> <summary> Writes debug-useful information. </summary> <param name="message">Debug message.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteWarning(System.String)"> <summary> Writes warning message. </summary> <param name="message">Warning message.</param> </member> <member name="M:Trisoft.ISHRemote.Cmdlets.TrisoftCmdletLogger.WriteError(System.Exception,System.Object)"> <summary> Writes non-terminating error. </summary> <param name="ex">Exception as a result of the error.</param> <param name="errorObject">Object that caused error.</param> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserGroup.AddIshUserGroup"> <summary> <para type="synopsis">The Add-IshUserGroup cmdlet adds the new user groups that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshUserGroup cmdlet adds the new user groups that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $metadata = Set-IshMetadataField -IshSession $ishSession -Name "FDESCRIPTION" -Level None -Value "Description of $userGroupName" $ishObject = Add-IshUserGroup -Name $userGroupName -Metadata $metadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Adding a user group.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.AddIshUserGroup.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.AddIshUserGroup.IshObject"> <summary> <para type="description">Array with the user groups to create. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.AddIshUserGroup.Name"> <summary> <para type="description">The name of the new user group.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.AddIshUserGroup.Metadata"> <summary> <para type="description">The metadata to set on the new user group.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup"> <summary> <para type="synopsis">The Find-IshUserGroup cmdlet finds user groups using ActivityFilter and MetadataFilter that are provided.</para> <para type="description">The Find-IshUserGroup cmdlet finds user groups using ActivityFilter and MetadataFilter that are provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserGroup </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve all user groups with their Basic metadata.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserGroup -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHUSERGROUPNAME") </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve one specific field for all user groups.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.UserGroup.FindIshUserGroup._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup"> <summary> <para type="synopsis">The Get-IshUserGroup cmdlet retrieves the metadat of user groups that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshUserGroup cmdlet retrieves the metadat of user groups that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshUserGroup -Id VUSERGROUPDEFAULTDEPARTMENT </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Get the Basic metadata of 'Default Department'.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.Id"> <summary> <para type="description">The user group identifiers for which to retrieve the metadata</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup.IshObject"> <summary> <para type="description">Array with the user groups for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.UserGroup.GetIshUserGroup._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserGroup.RemoveIshUserGroup"> <summary> <para type="synopsis">The Remove-IshUserGroup cmdlet removes the user groups that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshUserGroup cmdlet removes the user groups that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUserGroup -Id VUSERGROUPDEFAULTDEPARTMENT | Remove-IshUserGroup </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the user group and tries to remove it, which will fail if the user group is linked to objects.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.RemoveIshUserGroup.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.RemoveIshUserGroup.Id"> <summary> <para type="description">The identifier of the user group to remove</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.RemoveIshUserGroup.IshObject"> <summary> <para type="description">Array with the user groups to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserGroup.SetIshUserGroup"> <summary> <para type="synopsis">The Set-IshUserGroup cmdlet updates the user groups that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshUserGroup cmdlet updates the user groups that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUserGroup -Id VUSERGROUPDEFAULTDEPARTMENT | Set-IshMetadataField -Name DESCRIPTION -Value "Something new over ISHRemote" | Set-IshUserGroup </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the user group and adapts the client-side memory structure to hold a new description and sets in the repository.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.SetIshUserGroup.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.SetIshUserGroup.Id"> <summary> <para type="description">The identifier of the user group to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.SetIshUserGroup.Metadata"> <summary> <para type="description">The metadata to set for the user group</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserGroup.SetIshUserGroup.IshObject"> <summary> <para type="description">User groups for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserRole.AddIshUserRole"> <summary> <para type="synopsis">The Add-IshUserRole cmdlet adds the new user roles that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshUserRole cmdlet adds the new user roles that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin $metadata = Set-IshMetadataField -Name "FDESCRIPTION" -Level None -Value "Description of $userRoleName" $ishObject = Add-IshUserRole -Name $userRoleName -Metadata $metadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Adding a user role.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.AddIshUserRole.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.AddIshUserRole.IshObject"> <summary> <para type="description">Array with the user roles to create. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.AddIshUserRole.Name"> <summary> <para type="description">The name of the new user role.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.AddIshUserRole.Metadata"> <summary> <para type="description">The metadata to set for the new user role.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole"> <summary> <para type="synopsis">The Find-IshUserRole cmdlet finds user roles using ActivityFilter and MetadataFilter that are provided.</para> <para type="description">The Find-IshUserRole cmdlet finds user roles using ActivityFilter and MetadataFilter that are provided.</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserRole </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve all user roles with their Basic metadata.</para> </example> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserRole -IshSession $ishSession -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHUSERROLENAME") </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Retrieve one specific field for all user roles.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.UserRole.FindIshUserRole._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole"> <summary> <para type="synopsis">The Get-IshUserRole cmdlet retrieves the metadata of user roles that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshUserRole cmdlet retrieves the metadata of user roles that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshUserRole -Id VUSERROLEADMINISTRATOR </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Get the Basic metadata of 'Administrator' role.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.Id"> <summary> <para type="description">The user role identifiers for which to retrieve the metadata</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole.IshObject"> <summary> <para type="description">Array with the user roles for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.UserRole.GetIshUserRole._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserRole.RemoveIshUserRole"> <summary> <para type="synopsis">The Remove-IshUserRole cmdlet removes the user roles that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshUserRole cmdlet removes the user roles that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUserRole -Id VUSERROLEADMINISTRATOR | Remove-IshUserRole </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the user role and tries to remove it, which will fail if the user role is linked to objects.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.RemoveIshUserRole.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.RemoveIshUserRole.Id"> <summary> <para type="description">The identifier of the user role to remove</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.RemoveIshUserRole.IshObject"> <summary> <para type="description">Array with the user roles to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.UserRole.SetIshUserRole"> <summary> <para type="synopsis">The Set-IshUserRole cmdlet updates the user roles that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Set-IshUserRole cmdlet updates the user roles that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUserRole -Id VUSERROLEADMINISTRATOR | Set-IshMetadataField -Name DESCRIPTION -Value "Something new over ISHRemote" | Set-IshUserRole </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the user role and adapts the client-side memory structure to hold a new description and sets in the repository.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.SetIshUserRole.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.SetIshUserRole.Id"> <summary> <para type="description">The identifier of the user role to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.SetIshUserRole.Metadata"> <summary> <para type="description">The metadata to set for the user role</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.UserRole.SetIshUserRole.IshObject"> <summary> <para type="description">User roles for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.User.AddIshUser"> <summary> <para type="synopsis">The Add-IshUser cmdlet adds the new users that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Add-IshUser cmdlet adds the new users that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name FISHUSERLANGUAGE -Level None -ValueType Element -Value "VLANGUAGEEN" | Set-IshMetadataField -IshSession $ishSession -Name FUSERGROUP -Level None -ValueType Element -Value "VUSERGROUPDEFAULTDEPARTMENT" | Set-IshMetadataField -IshSession $ishSession -Name PASSWORD -Level None -Value "SomethingSecret" $ishObject = Add-IshUser -Name "NewUserName" -Metadata $metadata </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Adding a user</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.AddIshUser.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.AddIshUser.IshObject"> <summary> <para type="description">Array with the users to create. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.AddIshUser.Name"> <summary> <para type="description">The name of the new user.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.AddIshUser.Metadata"> <summary> <para type="description">The metadata to set for the new user.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.User.FindIshUser"> <summary> <para type="synopsis">The Find-IshUser cmdlet finds users using ActivityFilter and MetadataFilter that are provided</para> <para type="description">The Find-IshUser cmdlet finds users using ActivityFilter and MetadataFilter that are provided</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin (Find-IshUser).count </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Counting all users.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.FindIshUser.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.FindIshUser.ActivityFilter"> ActivityFilter <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.FindIshUser.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.FindIshUser.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.User.FindIshUser._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.User.GetIshUser"> <summary> <para type="synopsis">The Get-IshUser cmdlet retrieves the metadata of users that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Get-IshUser cmdlet retrieves the metadata of users that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUser </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the current user (Admin) Basic metadata.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.ActivityFilter"> <summary> <para type="description">The activity filter to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.Id"> <summary> <para type="description">The user identifiers for which to retrieve the metadata</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.MetadataFilter"> <summary> <para type="description">The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.RequestedMetadata"> <summary> <para type="description">The metadata fields to retrieve</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.GetIshUser.IshObject"> <summary> <para type="description">Users for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Cmdlets.User.GetIshUser._activityFilter"> <summary> Private field to store the IshType and provide a default for non-mandatory parameters </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.User.RemoveIshUser"> <summary> <para type="synopsis">The Remove-IshUser cmdlet removes the users that are passed through the pipeline or determined via provided parameters</para> <para type="description">The Remove-IshUser cmdlet removes the users that are passed through the pipeline or determined via provided parameters</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUser | Remove-IshUser </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the current user (Admin) and tries to remove it, which will fail if the user is linked to objects.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.RemoveIshUser.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.RemoveIshUser.Id"> <summary> <para type="description">The identifier of the user to remove</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.RemoveIshUser.IshObject"> <summary> <para type="description">Array with the users to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Cmdlets.User.SetIshUser"> <summary> <para type="synopsis">The Set-IshUser cmdlet updates the users that are passed through the pipeline or determined via provided parameters.</para> <para type="description">The Set-IshUser cmdlet updates the users that are passed through the pipeline or determined via provided parameters.</para> </summary> <example> <code> New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUser | Set-IshMetadataField -Name FISHEMAIL -Value "ishremote@example.com" | Set-IshUser </code> <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. Gets the current user (Admin) adapts the client-side memory structure to hold a new email address and sets in the repository.</para> </example> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.SetIshUser.IshSession"> <summary> <para type="description">The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.SetIshUser.Id"> <summary> <para type="description">The identifier of the user to update</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.SetIshUser.Metadata"> <summary> <para type="description">The metadata to set for the user</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Cmdlets.User.SetIshUser.IshObject"> <summary> <para type="description">Users for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection._openApiAM10Client"> <summary> OpenApi Access Management Web Service v1.0 NSwag generated client </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection._openApiISH30Client"> <summary> OpenApi InfoShare Web Service v3.0 NSwag generated client </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection.disposedValue"> <summary> Tracking standard dispose pattern </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.Net.Http.HttpClient,Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters)"> <summary> Initializes a new instance of <c>InfoShareOpenApiWithOpenIdConnectConnection</c> class. </summary> <param name="logger">Instance of Interfaces.ILogger implementation</param> <param name="httpClient">Incoming reused, probably Ssl/Tls initialized already.</param> <param name="infoShareOpenIdConnectConnectionParameters">Connection parameters.</param> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection.GetOpenApiISH30Client"> <summary> Create an OpenAPI InfoShare 3.0 proxy HttpClient with OpenIdConnect authentication need a way to pass the Access/Bearer token. This method wraps the token up in an authentication/bearer token. </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenApiWithOpenIdConnectConnection.GetOpenApiAM10Client"> <summary> Create an OpenAPI Access Management 1.0 proxy HttpClient with OpenIdConnect authentication need a way to pass the Access/Bearer token. This method wraps the token up in an authentication/bearer token. </summary> <returns>The proxy</returns> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase"> <summary> OpenIdConnect base class to attempt to single-source all token retrieval functions. To be shared between OpenApiWithOpenIdConnect and WcfSoapWithOpenIdConnect </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase._logger"> <summary> Logger </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase._httpClient"> <summary> HttpClient. Incoming reused, probably Ssl/Tls initialized already. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase._connectionParameters"> <summary> Parameters that configure the connection behavior. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.Net.Http.HttpClient,Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters)"> <summary> Initializes a base instance of <c>InfoShareOpenIdConnectConnectionBase</c> class. </summary> <param name="logger">Instance of Interfaces.ILogger implementation</param> <param name="httpClient">Incoming reused, probably Ssl/Tls initialized already.</param> <param name="infoShareOpenIdConnectConnectionParameters">OpenIdConnect connection parameters to be shared with WcfSoapWithOpenIdConnect and OpenApiWithOpenIdConnect</param> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase.RefreshBeforeExpiration"> <summary> Gets or sets when access token should be refreshed (relative to its expiration time). Default skew time is 3 minutes. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase.IsTokenAlmostExpired"> <summary> Checks whether the token is issued and still valid with a skew time. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase.GetTokensOverClientCredentialsAsync(System.Threading.CancellationToken)"> <summary> OidcClient-based get Bearer/Access based on class parameters. Will refresh if possible. </summary> <param name="cancellationToken">Default</param> <returns>New InfoShareOpenIdConnectTokens with new or refreshed valeus</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionBase.GetAccessToken"> <summary> Returns a valid Access Token that can be used as Issued Token or Bearer Token on the various communication technologies. If the token is expired an explicit 'Authorization Code Flow with PKCE' (over System Browser) or 'Client Credentials' flow will happen. If the token is almost expired, a silent Refresh flow will happen. </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters"> <summary> Optional InfoShare Wcf connection parameters. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.InfoShareWSUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured ISHWS Url is "https://ish.example.com/ISHWS/" while you perhaps are doing https://localhost/ or behind the configured load balancer. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.ClientAppId"> <summary> Client Application Id as configured on Access Management which allows a http://127.0.0.1:SomePort redirect url </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.Scope"> <summary> Existing scopes as configured on Access Management </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.RedirectUri"> <summary> When Sign In succeeded the browser is redirect to this link. Typically https://ish.example.com/ISHAM/Account/loggedIn?clientId=c826e7e1-c35c-43fe-9756-e1b61f44bb40 where the ClientId GUID is the ISHAM Account. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.AuthenticationType"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer AuthenticationType. Expected values are WindowsMixed, UserNameMixed and AccessManagement. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.IssuerUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer Url. Expected values are .../issue/wstrust/mixed/username or .../ISHAM/. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.Tokens"> <summary> Collects various tokens with expiration date </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.ClientId"> <summary> ClientId to request for an access token </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.ClientSecret"> <summary> ClientSecret to request for an access token </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.Timeout"> <summary> Timeout to control Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.IssueTimeout"> <summary> Timeout to control Send/Receive timeouts of WCF when issuing a token </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.ServiceTimeout"> <summary> Timeout to control Send/Receive timeouts of WCF for InfoShareWS proxies </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.SystemBrowserTimeout"> <summary> Timeout to control the wait of the interactive system browser localhost redirect flow </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters.IgnoreSslPolicyErrors"> <summary> If True, certificate validation for HTTPS and the Service will be skipped </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectLocalHttpEndpoint"> <summary> ISHRemote will listen to the Redirect Url (typically 127.0.01 and a free port) where the System Browser will federate out for authentication but eventually will call back to ISHRemote with InfoShareOpenIdConnectTokens </summary> <remarks>Hat tip to /src/Clients/Tridion.AccessManagement.Client.Desktop/LocalHttpEndpoint.cs</remarks> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectLocalHttpEndpoint.Dispose"> <summary> Listener has to be kept alive to allow 2nd redirect to page showing 'You are now signed in.'/'This browser tab can be closed.' to be shown. </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectSystemBrowser"> <summary> Knows how to reliably launch your default web browser (the one that opens any https:// url in any application) across the supported platforms Windows, Linux and MacOS </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectSystemBrowser._logger"> <summary> Logger </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectTokens"> <summary> Container to hold and refresh your Access/Bearer tokens and more which are eventually pushed in the wire over an HttpClient class </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectTokens.AccessToken"> <summary> Access Token is also known as Bearer Token </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.BearerCredentials"> <summary> SOAP web services (/ISHWS/OWCF/) with OpenIdConnect authentication need a way to pass the Access/Bearer token. This class wraps the token up in a SAML token which passes nicely over Windows Communication Foundation. Used in InfoShareWcfSoapWithOpenIdConnectConnection class </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection"> <summary> Dynamic proxy (so without app.config) generation of Service References towards the InfoShare Web Services writen in Windows Communication Foundation (WCF) protected by OpenIdConnect security protocol. On ISHRemote v1 and earlier, so in turn before InfoShare 15 and earlier, this class was your starting point for dynamic proxy (so without app.config) generation of Service References. The inital class was written in .NET Framework style. Inspired by https://devblogs.microsoft.com/dotnet/wsfederationhttpbinding-in-net-standard-wcf/ this class has pragmas to illustrate .NET Framework and .NET 6.0+ style side-by-side. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Annotation25"> <summary> Annotation25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Application25"> <summary> Application25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.DocumentObj25"> <summary> DocumentObj25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Folder25"> <summary> Folder25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.User25"> <summary> User25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.UserRole25"> <summary> UserRole25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.UserGroup25"> <summary> UserGroup25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.ListOfValues25"> <summary> ListOfValues25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.PublicationOutput25"> <summary> PublicationOutput25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.OutputFormat25"> <summary> OutputFormat25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Settings25"> <summary> Settings25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.EDT25"> <summary> EDT25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.EventMonitor25"> <summary> EventMonitor25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Baseline25"> <summary> Baseline25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.MetadataBinding25"> <summary> MetadataBinding25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Search25"> <summary> Search25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.TranslationJob25"> <summary> TranslationJob25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.TranslationTemplate25"> <summary> TranslationTemplate25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.BackgroundTask25"> <summary> BackgroundTask25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._serviceUriByServiceName"> <summary> Service URIs by service. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._commonBinding"> <summary> Binding that is common for every endpoint. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._annotationClient"> <summary> Proxy for annotation </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._applicationClient"> <summary> Proxy for application </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._documentObjClient"> <summary> Proxy for document obj </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._folderClient"> <summary> Proxy for folder </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._userClient"> <summary> Proxy for user </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._userRoleClient"> <summary> Proxy for user role </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._userGroupClient"> <summary> Proxy for user group </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._listOfValuesClient"> <summary> Proxy for LOV </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._publicationOutputClient"> <summary> Proxy for publication output </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._outputFormatClient"> <summary> Proxy for output format </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._settingsClient"> <summary> Proxy for settings </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._EDTClient"> <summary> Proxy for EDT </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._eventMonitorClient"> <summary> Proxy for event monitor </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._baselineClient"> <summary> Proxy for baseline </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._metadataBindingClient"> <summary> Proxy for metadata binding </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._searchClient"> <summary> Proxy for search </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._translationJobClient"> <summary> Proxy for translation job </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._translationTemplateClient"> <summary> Proxy for translation template </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection._backgroundTaskClient"> <summary> Proxy for background task </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.Net.Http.HttpClient,Trisoft.ISHRemote.Connection.InfoShareOpenIdConnectConnectionParameters)"> <summary> Initializes a new instance of <c>InfoShareWcfSoapWithOpenIdConnectConnection</c> class. </summary> <param name="logger">Instance of Interfaces.ILogger implementation</param> <param name="httpClient">Incoming reused, probably Ssl/Tls initialized already.</param> <param name="infoShareOpenIdConnectConnectionParameters">OpenIdConnect connection parameters to be shared with WcfSoapWithOpenIdConnect and OpenApiWithOpenIdConnect</param> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.InfoShareWSBaseUri"> <summary> Root uri for the Web Services </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetAnnotation25Channel"> <summary> Create a /Wcf/API25/Annotation.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetApplication25Channel"> <summary> Create a /Wcf/API25/Application.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetDocumentObj25Channel"> <summary> Create a /Wcf/API25/DocumentObj.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetFolder25Channel"> <summary> Create a /Wcf/API25/Folder.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetUser25Channel"> <summary> Create a /Wcf/API25/User.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetUserRole25Channel"> <summary> Create a /Wcf/API25/UserRole.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetUserGroup25Channel"> <summary> Create a /Wcf/API25/UserGroup.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetListOfValues25Channel"> <summary> Create a /Wcf/API25/ListOfValues.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetPublicationOutput25Channel"> <summary> Create a /Wcf/API25/PublicationOutput.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetOutputFormat25Channel"> <summary> Create a /Wcf/API25/OutputFormat.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetSettings25Channel"> <summary> Create a /Wcf/API25/Settings.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetEDT25Channel"> <summary> Create a /Wcf/API25/Edt.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetEventMonitor25Channel"> <summary> Create a /Wcf/API25/EventMonitor.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetBaseline25Channel"> <summary> Create a /Wcf/API25/Baseline.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetMetadataBinding25Channel"> <summary> Create a /Wcf/API25/MetadataBinding.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetSearch25Channel"> <summary> Create a /Wcf/API25/Search.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetTranslationJob25Channel"> <summary> Create a /Wcf/API25/TranslationJob.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetTranslationTemplate25Channel"> <summary> Create a /Wcf/API25/TranslationTemplate.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetBackgroundTask25Channel"> <summary> Create a /Wcf/API25/BackgroundTask.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.ResolveServiceUris"> <summary> One location to bind relative urls to service names </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.LoadConnectionConfiguration"> <summary> Returns the connection configuration (loaded from base [InfoShareWSBaseUri]/connectionconfiguration.xml) </summary> <returns>The connection configuration.</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.GetBearerCredentials"> <summary> NET6+ SOAP web services (/ISHWS/OWCF/) with OpenIdConnect authentication need a way to pass the Access/Bearer token. This method wraps the token up in a SAML token which passes nicely over Windows Communication Foundation as Bearer Token on the Endpoint. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Dispose"> <summary> Disposes the object </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithOpenIdConnectConnection.Close"> <summary> Disposes the object </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection"> <summary> Dynamic proxy (so without app.config) generation of Service References towards the InfoShare Web Services writen in Windows Communication Foundation (WCF) protected by WS-Trust (aka WS-Federation active) SOAP protocol. On ISHRemote v1 and earlier, so in turn before InfoShare 15 and earlier, this class was your starting point for dynamic proxy (so without app.config) generation of Service References. The inital class was written in .NET Framework style. Inspired by https://devblogs.microsoft.com/dotnet/wsfederationhttpbinding-in-net-standard-wcf/ this class has pragmas to illustrate .NET Framework and .NET 6.0+ style side-by-side. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Annotation25"> <summary> Annotation25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Application25"> <summary> Application25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.DocumentObj25"> <summary> DocumentObj25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Folder25"> <summary> Folder25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.User25"> <summary> User25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.UserRole25"> <summary> UserRole25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.UserGroup25"> <summary> UserGroup25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.ListOfValues25"> <summary> ListOfValues25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.PublicationOutput25"> <summary> PublicationOutput25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.OutputFormat25"> <summary> OutputFormat25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Settings25"> <summary> Settings25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.EDT25"> <summary> EDT25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.EventMonitor25"> <summary> EventMonitor25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Baseline25"> <summary> Baseline25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.MetadataBinding25"> <summary> MetadataBinding25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Search25"> <summary> Search25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.TranslationJob25"> <summary> TranslationJob25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.TranslationTemplate25"> <summary> TranslationTemplate25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.BackgroundTask25"> <summary> BackgroundTask25 </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._logger"> <summary> Logger </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._httpClient"> <summary> HttpClient. Incoming reused, probably Ssl/Tls initialized already. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._connectionParameters"> <summary> Parameters that configure the connection behavior. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._issuerAuthenticationType"> <summary> The binding type that is required by the end point of the WS-Trust issuer. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._issuerWSTrustEndpointUri"> <summary> The WS-Trust endpoint for the Security Token Service that provides the functionality to issue tokens as specified by the issuerwstrustbindingtype. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._infoShareWSAppliesTo"> <summary> WS STS Realm to issue tokens for </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._serviceUriByServiceName"> <summary> Service URIs by service. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._issuedToken"> <summary> The token that is used to access the services. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._commonBinding"> <summary> Binding that is common for every endpoint. </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._annotationClient"> <summary> Proxy for annotation </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._applicationClient"> <summary> Proxy for application </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._documentObjClient"> <summary> Proxy for document obj </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._folderClient"> <summary> Proxy for folder </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._userClient"> <summary> Proxy for user </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._userRoleClient"> <summary> Proxy for user role </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._userGroupClient"> <summary> Proxy for user group </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._listOfValuesClient"> <summary> Proxy for LOV </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._publicationOutputClient"> <summary> Proxy for publication output </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._outputFormatClient"> <summary> Proxy for output format </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._settingsClient"> <summary> Proxy for settings </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._EDTClient"> <summary> Proxy for EDT </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._eventMonitorClient"> <summary> Proxy for event monitor </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._baselineClient"> <summary> Proxy for baseline </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._metadataBindingClient"> <summary> Proxy for metadata binding </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._searchClient"> <summary> Proxy for search </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._translationJobClient"> <summary> Proxy for translation job </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._translationTemplateClient"> <summary> Proxy for translation template </summary> </member> <member name="F:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection._backgroundTaskClient"> <summary> Proxy for background task </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.Net.Http.HttpClient,Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters)"> <summary> Initializes a new instance of <c>InfoShareWcfSoapWithWsTrustConnection</c> class. </summary> <param name="logger">Instance of Interfaces.ILogger implementation</param> <param name="httpClient">Incoming reused, probably Ssl/Tls initialized already.</param> <param name="infoShareWcfSoapWithWsTrustConnectionParameters">Connection parameters.</param> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.InfoShareWSBaseUri"> <summary> Root uri for the Web Services </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.RefreshBeforeExpiration"> <summary> Gets or sets when access token should be refreshed (relative to its expiration time). Default skew time is 3 minutes. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.IsTokenAlmostExpired"> <summary> Checks whether the token is issued and still valid with a skew time. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetAnnotation25Channel"> <summary> Create a /Wcf/API25/Annotation.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetApplication25Channel"> <summary> Create a /Wcf/API25/Application.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetDocumentObj25Channel"> <summary> Create a /Wcf/API25/DocumentObj.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetFolder25Channel"> <summary> Create a /Wcf/API25/Folder.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetUser25Channel"> <summary> Create a /Wcf/API25/User.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetUserRole25Channel"> <summary> Create a /Wcf/API25/UserRole.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetUserGroup25Channel"> <summary> Create a /Wcf/API25/UserGroup.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetListOfValues25Channel"> <summary> Create a /Wcf/API25/ListOfValues.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetPublicationOutput25Channel"> <summary> Create a /Wcf/API25/PublicationOutput.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetOutputFormat25Channel"> <summary> Create a /Wcf/API25/OutputFormat.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetSettings25Channel"> <summary> Create a /Wcf/API25/Settings.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetEDT25Channel"> <summary> Create a /Wcf/API25/Edt.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetEventMonitor25Channel"> <summary> Create a /Wcf/API25/EventMonitor.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetBaseline25Channel"> <summary> Create a /Wcf/API25/Baseline.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetMetadataBinding25Channel"> <summary> Create a /Wcf/API25/MetadataBinding.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetSearch25Channel"> <summary> Create a /Wcf/API25/Search.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetTranslationJob25Channel"> <summary> Create a /Wcf/API25/TranslationJob.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetTranslationTemplate25Channel"> <summary> Create a /Wcf/API25/TranslationTemplate.svc proxy </summary> <returns>The proxy</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.GetBackgroundTask25Channel"> <summary> Create a /Wcf/API25/BackgroundTask.svc proxy </summary> <returns>The proxy</returns> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.IssuerAuthenticationType"> <summary> Gets the binding type that is required by the end point of the WS-Trust issuer. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.IssuerWSTrustEndpointUri"> <summary> Gets the WS-Trust endpoint for the Security Token Service that provides the functionality to issue tokens as specified by the issuerwstrustbindingtype. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.IssuedToken"> <summary> Gets the token that is used to access the services. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.ResolveServiceUris"> <summary> One location to bind relative urls to service names </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.LoadConnectionConfiguration"> <summary> Returns the connection configuration (loaded from base [InfoShareWSBaseUri]/connectionconfiguration.xml) </summary> <returns>The connection configuration.</returns> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.IssueToken"> <summary> Issues the token Mostly copied from Service References </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Dispose"> <summary> Disposes the object </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnection.Close"> <summary> Disposes the object </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters"> <summary> Optional InfoShare Wcf connection parameters. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.InfoShareWSUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured ISHWS Url is "https://ish.example.com/ISHWS/" while you perhaps are doing https://localhost/ or behind the configured load balancer. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.AuthenticationType"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer AuthenticationType. Expected values are WindowsMixed, UserNameMixed and AccessManagement. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.IssuerUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer Url. Expected values are .../issue/wstrust/mixed/username or .../ISHAM/. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.Credential"> <summary> The connection credential. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.Timeout"> <summary> Timeout to control Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.IssueTimeout"> <summary> Timeout to control Send/Receive timeouts of WCF when issuing a token </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.ServiceTimeout"> <summary> Timeout to control Send/Receive timeouts of WCF for InfoShareWS proxies </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.AutoAuthenticate"> <summary> If True, authenticate immediately; otherwise, authenticate on the first service request. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.InfoShareWcfSoapWithWsTrustConnectionParameters.IgnoreSslPolicyErrors"> <summary> If True, certificate validation for HTTPS and the Service will be skipped </summary> </member> <member name="T:Trisoft.ISHRemote.Connection.IshConnectionConfiguration"> <summary> The connectionconfiguration.xml file is a discovery file that teels you how the web services are configured. Since 2013/10.0.0 it indicates the token issuer for the active authentication flow. More recently we want to know the application name (used by ASMX web services). </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.SoftwareVersion"> <summary> The clientconfiguration.xml discovery file tells us the server-side CMS software version is ... eg. 14.0.3 </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.ApplicationName"> <summary> The clientconfiguration.xml discovery file tells us the ApplicationName like "InfoShareAuthor" or "InfoShareAuthorDITA" (where DITA is the projectsuffix). Historically it was the TriDKApp registry key ;-) </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.InfoShareWSUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured ISHWS Url is "https://ish.example.com/ISHWS/" while you perhaps are doing https://localhost/ or behind the configured load balancer. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.AuthenticationType"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer AuthenticationType. Expected values are WindowsMixed, UserNameMixed and AccessManagement. </summary> </member> <member name="P:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.IssuerUrl"> <summary> The clientconfiguration.xml discovery file tells us the configured Issuer Url. Expected values are .../issue/wstrust/mixed/username or .../ISHAM/. </summary> </member> <member name="M:Trisoft.ISHRemote.Connection.IshConnectionConfiguration.#ctor(System.String)"> <summary> Constructor </summary> <param name="xmlConnectionConfiguration">An xml string holding the /ISHWS/connectionconfiguration.xml content</param> </member> <member name="M:Trisoft.ISHRemote.ExtensionMethods.OpenApiISH30EnumerationsExtensions.ToOpenApiISH30FieldGroup(Trisoft.ISHRemote.Objects.Enumerations.RequestedMetadataGroup)"> <summary> OpenApi (dd 20211228) implements FieldGroup as derived from ISHRemote RequestedMetadataGroup, should be 1-1 conversion to server-side decide which fields to retrieve </summary> </member> <member name="M:Trisoft.ISHRemote.ExtensionMethods.OpenApiISH30EnumerationsExtensions.ToISHFieldLevel(Trisoft.ISHRemote.OpenApiISH30.Level)"> <summary> OpenApi (dd 20211228) implements Field Level, needs mapping to ISHRemote levels </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.AppDomainModuleAssemblyInitializer"> <summary> PROBLEM: Solves the PS51/NET48 problem of OidcClient which continuously threw 'Error connecting to https://sts.windows.net/{tenant}/.well-known/openid-configuration. Operation is not valid due to the current state of the object' in GetDiscoveryDocumentAsync as described on https://github.com/IdentityModel/Documentation/issues/13 EARLIER SOLUTION: See AppDomainAssemblyResolveHelper.cs which was loaded in typical first cmdlet a SessionCmdlet.cs THIS SOLUTION: NET 4.8 comes with System.Runtime.CompilerServices.Unsafe v4.0.4 while OidcClient is compiled against v5.0.0 and OpenApi/NSwag expects v6.0.0. Few solutions describe to do .config assemblyBinding redirects for System.Text.Json to minimally v5.0.2 and System.Runtime.CompilerServices.Unsafe to minimally v5.0.0. On PowerShell however, the powershell.exe.config is off limits, hence the below AssemblyResolve solution. MAPPINGS: * System.Runtime.CompilerServices.Unsafe requested 4.0.4.1 or 5.0.0.0 but we now return 6.0.0.0 * System.Text.Json requested 5.0.0.0 but we now return 5.0.0.2 * IdentityModel.OidcClient requested but we now return * Microsoft.Bcl.AsyncInterfaces requested 5.0.0.0 but we now return 6.0.0.0 * System.ComponentModel.Annotations requested 4.2.0.0 but we now return 4.2.1.0 (for NET48/OpenApi clients) * ...see code below </summary> <remarks>Focus was to getting this working on NETFramework, more implementation is required to align with proposed solution of https://devblogs.microsoft.com/powershell/resolving-powershell-module-assembly-dependency-conflicts/ and https://github.com/rjmholt/ModuleDependencyIsolationExample/blob/master/new/JsonModule.Cmdlets/JsonModuleInitializer.cs regarding Engine introduction.</remarks> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.AppDomainModuleAssemblyInitializer._forcedLoadedAssemblies"> <summary> Storing forcefully loaded assemblies in the dictionary at the time of writing on Windows11/NET4.8.1 </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.AppDomainModuleAssemblyInitializer.OnImport"> <summary> Early registration of my AssemblyResolve call. </summary> <remarks>Earlier than the AppDomainAssemblyResolveHelper.cs which was loaded in typical first cmdlet a SessionCmdlet.cs</remarks> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.CertificateValidationHelper"> <summary> Provides optional callback overwrite and restore function. Do note however that ServicePointManager.ServerCertificateValidationCallback changes apply to the whole AppDomain. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.CertificateValidationHelper.OverrideCertificateValidation"> <summary> Sets our custom AppDomain ssl/certificate overwrite callback using ServicePointManager, including a backup of any existing callback </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.CertificateValidationHelper.RestoreCertificateValidation"> <summary> Removes our custom AppDomain ssl/certificate overwrite callback using ServicePointManager by restoring our ealier backup of any existing callback </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch"> <summary> Class that matches an match xml element and holds the values to match a doctype or rootword with its generalized doctype and rootword </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.RootElement"> <summary> Name of the rootelement of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.DtdPublicId"> <summary> PublicId of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.DtdSystemId"> <summary> SystemId of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.GeneralizedRootElement"> <summary> Name of the rootelement of the generalized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.GeneralizedDtdPublicId"> <summary> PublicId of the generalized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch.GeneralizedDtdSystemId"> <summary> System id of the generalized DTD </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter"> <summary> Filtervalues to use for searching in the DITA generalization mapping file </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter.#ctor"> <summary> Constructor </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter.RootElement"> <summary> Name of the rootelement of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter.DtdPublicId"> <summary> PublicId of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter.DtdSystemId"> <summary> SystemId of the specialized DTD </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter.IgnoreMatchesWithMissingGeneralizedDTDInfo"> <summary> If true ignores rows that do not have a generalizeddtdpublicid or generalizeddtdsystemid attribute or without a generalized root element attribute </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization"> <summary> This class can be used to convert a specialized DITA DTD xml to a more generic DITA DTD xml </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization._xmlSpecializedXmlResolver"> <summary> An instance of the XmlResolverUsingCatalog class. This can be used to load the specialized xml file </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization._xmlGeneralizedXmlResolver"> <summary> An instance of the XmlResolverUsingCatalog class. This can be used to load the generalized xml file </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization._xmlGeneralizationCatalogMapping"> <summary> An instance of the XmlGeneralizationCatalogMapping class. This is used to do the mapping of the specialized DTD to the generalized DTD </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.#ctor(Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog,Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog,Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping)"> <summary> Creates an instance of this class with the given parameters </summary> <param name="specializedXmlResolver">XmlResolver for a Catalog location with specialized DTDs</param> <param name="generalizedXmlResolver">XmlResolver for a Catalog with the base DTDs</param> <param name="generalizationCatalogMapping">XmlGeneralizationCatalogMapping with the mapping file to find the generalized DTD for a certain specialized DTD</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.AttributesToGeneralizeToProps"> <summary> An array with the attribute names specialized from the DITA "props" attribute </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.AttributesToGeneralizeToBase"> <summary> An array with the attribute names specialized from the DITA "base" attribute </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.Generalize(System.IO.FileInfo,System.IO.FileInfo)"> <summary> Generalizes the given specialized xml file. When the generalization succeeds a file is created at the location given in generalizedXmlFileLocation When the generalization fails a file is created at the location given in errorLogLocation. If this is empty no error file is created. </summary> <param name="specializedXmlFileLocation">The location of the specialized xml file</param> <param name="generalizedXmlFileLocation">The location for the generalized xml file</param> <returns>true if the generalization succeeded, false if not</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.GetGeneralizedDTD(System.String)"> <summary> Parses the xml at the given file location and tries to lookup the generalized dtd in the generalized-catalog-mapping.xml file. </summary> <param name="specializedXmlFileLocation">File location of the specialized xml file</param> <returns> If a match is found in the generalized-catalog-mapping.xml file, a XmlGeneralizedConstructionInfo with the necess info (DTD/root element/encoding) to create the generalized xml is returned If no match is found an InvalidOperationException is raised </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.GetGeneralizedElement(System.Xml.XmlReader,Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo)"> <summary> Determines the generalized element name from the specialized element To do this, it uses the class attributes of the specialized element and the domains and rootelement of the generalized DTD </summary> <param name="xmlReader">XmlReader positioned on an Element node</param> <param name="xmlGeneralizedConstructionInfo">XmlGeneralizedConstructionInfo with the info of the generalized DTD</param> <returns>The element name of the generalized element</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.InitializeXmlReaderSettings(Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog,System.Xml.ValidationType)"> <summary> Creates an XmlReaderSettings with the given resolver, validationType and ValidationCallbackHandler </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.InitializeXmlWriterSettings(System.Text.Encoding)"> <summary> Creates an XmlWriterSettings with the given encoding </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.Validate(System.String,System.Xml.XmlReaderSettings)"> <summary> Loads and Validates the xml at the given file location. It uses the given xmlresolver Throws an exception when validation fails </summary> <param name="xmlFileLocation">File location of the generalized xml file</param> <param name="xmlReaderSettings">XmlReaderSettings object with ValidationType specified</param> <returns>true if the file is valid, false if not</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.ValidationHandler(System.Object,System.Xml.Schema.ValidationEventArgs)"> <summary> Handler method for validation errors. Throws an exception when an error is encountered </summary> <param name="sender">Sender of the validation event</param> <param name="args">Validation error arguments</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.GetGeneralizedDomainsAttribute(Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch)"> <summary> This function return the domains attribute that is on the root element of the generalized DTD </summary> <param name="match">DitaXmlCatalogMatch with the matching generalization catalog entry</param> <returns>DtdDomains object</returns> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass"> <summary> This class can be used to parse and store a DITA "class" attribute string </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass.#ctor(System.String)"> <summary> Initializes an instance of the DtdClass with the given classAttribute </summary> <param name="classAttribute">DITA "class" attribute string</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass.ClassAttribute"> <summary> Entire DITA "class" attribute string </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass.PrefixPart"> <summary> DITA "class" prefix part, containing the "+" or "-" sign </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass.DomainElementParts"> <summary> List of the DITA "class" domain/elementname parts in order </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClass.DomainElementPartsInReversedOrder"> <summary> List of the DITA "class" domain/elementname parts in reverse order </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomains"> <summary> This class can be used to parse and store a DITA "domains" attribute string </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomains.#ctor(System.String)"> <summary> Initializes an instance of the DtdDomains with the given domainsAttribute </summary> <param name="domainsAttribute">DITA "domains" attribute string</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomains.DomainsParts"> <summary> List of the DITA "domain" parts </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomains.DomainsAttribute"> <summary> Entire DITA "domains" attribute string </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomainsPart.#ctor(System.String)"> <summary> Initializes an instance of the DtdDomains with the given domainsAttribute </summary> <param name="domainsAttributePart">DITA "domains" attribute part string of the form "topic ui-d"</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomainsPart.DTDName"> <summary> DTD name part of the domain part </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdDomainsPart.DomainName"> <summary> Domain name part of the domains part </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClassDomainElementPart"> <summary> This class stores one "domain/elementname" part of a DITA "class" attribute string </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClassDomainElementPart.#ctor(System.String)"> <summary> Initializes an instance of the DtdClassDomainElementPart with the given classAttributePart </summary> <param name="classAttributePart">DITA "class" attribute part with a domain/elementname string</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClassDomainElementPart.Domain"> <summary> Domain of the DTD class part </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.DtdClassDomainElementPart.ElementName"> <summary> ElementName of the DTD class part </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo"> <summary> Class that holds the necessary info to create the generalized xml file: the dtd into, rootword, encoding and domains </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.#ctor"> <summary> Initializes an instance of the XmlGeneralizedConstructionInfo </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.RootElement"> <summary> Name of the rootelement for the generalized Xml </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.DtdPublicId"> <summary> PublicId for the generalized Xml </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.DtdSystemId"> <summary> SystemId for the generalized Xml </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.DtdInternalSubset"> <summary> Internal DTD definitions for the generalized Xml </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.Encoding"> <summary> Encoding for the generalized Xml </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralization.XmlGeneralizedConstructionInfo.AllowedDomains"> <summary> DTD Domains allowed for the generalized Xml </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping"> <summary> Functionality to find the generalized DTD for a specialized DTD </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping.#ctor(System.String)"> <summary> Creates an instance of this class and loads the generalization catalog mapping file </summary> <param name="generalizedCatalogMappingUri">Location of the generalization catalog mapping file, typically 'c:\infoshare\web\author\asp\doctypes\generalization-catalog-mapping.xml'.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping.GetPreferredMatch(Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatchFilter)"> <summary> Searches for all matches on the specified filter criterea and returns the preferred match. The preferred match is found as follows: First we try to find a match entry where the dtdpublicid + dtdsystemid + rootelement all match -> if we find matches, the first one is returned Second we try to find a match entry where the dtdpublicid + rootelement both match -> if we find matches, the first one is returned Third we try to find a match entry where the dtdsystemid + rootelement both match -> if we find matches, the first one is returned Last we try to find a match entry where the rootelement matches -> if we find matches, the first one is returned </summary> <param name="filter">filter criterea to search on</param> <returns>The preferred match</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping.ReadCatalogMapping(System.String)"> <summary> Reads the generalized-catalog-mapping.xml file into an XElement structure </summary> <param name="catalogMappingLocation"></param> <returns></returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.DitaXmlGeneralizationCatalogMapping.FindFirstFilterMatch(System.Func{Trisoft.ISHRemote.HelperClasses.DitaXmlCatalogMatch,System.Boolean},System.Boolean)"> <summary> This function executes the given function and returns the first match that also complies to the ignoreMatchesWithMissingGeneralizedDTDInfo parameter </summary> <param name="matchFunction">Function to fine the matches</param> <param name="ignoreMatchesWithMissingGeneralizedDTDInfo">When true: removes all matches that do not have a generalizeddtdpublicid or generalizeddtdsystemid attribute or without a generalized root element attribute</param> <returns>The first matching mapping elements</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToStatusFilter``1(Trisoft.ISHRemote.Objects.Enumerations.StatusFilter)"> <summary> Convert a statusfilter string to an enumeration value. </summary> <param name="statusFilter">The statusfilter string that needs to be converted.</param> <returns>A eISHStatusgroup enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToProgressStatusFilter``1(Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter)"> <summary> Convert a progressStatusFilter string to an enumeration value. </summary> <param name="progressStatusFilter">The progressStatusFilter string that needs to be converted.</param> <returns>A eProgressStatusFilter enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToBackgroundTaskStatusFilter``1(Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter)"> <summary> Convert a BackgroundTaskStatusFilter string to an enumeration value. </summary> <param name="backgroundTaskStatusFilter">The backgroundTaskStatusFilter string that needs to be converted.</param> <returns>A eBackgroundTaskStatusFilter enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToUserFilter``1(Trisoft.ISHRemote.Objects.Enumerations.UserFilter)"> <summary> Convert a userFilter string to an enumeration value. </summary> <param name="userFilter">The userFilter string that needs to be converted.</param> <returns>A UserFilter enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToEventLevelFilter``1(Trisoft.ISHRemote.Objects.Enumerations.EventLevel)"> <summary> Convert a eventLevelFilter string to an enumeration value. </summary> <param name="eventLevelFilter">The eventLevelFilter string that needs to be converted.</param> <returns>A eventLevelFilter enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToActivityFilter``1(Trisoft.ISHRemote.Objects.Enumerations.ActivityFilter)"> <summary> Convert a activity to an enumeration value </summary> <param name="activityFilter">The activity filter that needs to be converted.</param> <returns>A eISHActivityFilter enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToBaseFolder``1(Trisoft.ISHRemote.Objects.Enumerations.BaseFolder)"> <summary> Convert a basefolder to an enumeration value </summary> <param name="baseFolder">The base folder that needs to be converted.</param> <returns>A eISHBaseFolder enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToBaseFolder``1(System.String)"> <summary> Convert a basefolder to an enumeration value </summary> <param name="baseFolder">The base folder that needs to be converted.</param> <returns>A eISHBaseFolder enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToFolderType``1(Trisoft.ISHRemote.Objects.Enumerations.IshFolderType)"> <summary> Convert a folderType to an enumeration value </summary> <param name="folderType">The folder type that needs to be converted.</param> <returns>eISHFolderType enumeration value.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.EnumConverter.ToIshType``1(Trisoft.ISHRemote.Objects.Enumerations.ISHType)"> <summary> Convert a ishType to an enumeration value </summary> <param name="ishType">The folder type that needs to be converted.</param> <returns>eISHFolderType enumeration value.</returns> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.FileNameHelper"> <summary> Helper class that contains methods to resolve file names. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.GetDefaultObjectFileName(System.String,Trisoft.ISHRemote.Objects.Public.IshObject,System.String)"> <summary> Outputs an filename based on an ishobject. </summary> <param name="path">The path where the file needs to be stored.</param> <param name="ishObject">The <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/>.</param> <param name="extension">The file extension.</param> <returns> A string with following format #Title#=#LogicalId#=#Version#=(#Language#=)(#Resolution#).#Extension# Values between brackets are optional. </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.GetDefaultPublicationOutputFileName(System.String,Trisoft.ISHRemote.Objects.Public.IshObject,System.String)"> <summary> Outputs a filename based on an ishobject (publicationoutput variant). </summary> <param name="path">The path where the file needs to be stored.</param> <param name="ishObject">The <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/>.</param> <param name="extension">The file extension.</param> <returns> A string with following format #Title#=#LogicalId#=#Version#=#OutputFormat#=#LanguageCombination#.#Extension# </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.EscapeFileName(System.String)"> <summary> Function that cleans up invalid characters from of a file name. </summary> <param name="fileName">The file name.</param> <returns>A valid file name (without invalid characters).</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.EscapePath(System.String)"> <summary> Function that cleans up invalid characters from of a file path. </summary> <param name="path">The file path.</param> <returns>A valid file path (without invalid characters).</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.Encode(System.String)"> <summary> Encode the "=" char in a string. </summary> <param name="s">String to encode.</param> <returns>A string where all "=" chars are replaced by "%3d".</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.FileNameHelper.Decode(System.String)"> <summary> Decodes the "=" char in a string. </summary> <param name="s">String to decode.</param> <returns>A string where all "%3d" chars are replaced by "=".</returns> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.IshObfuscator"> <summary> This class can be used to obfuscate a file. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.IshObfuscator._shortWordSubstitutions"> <summary> To replace words up to 20 characters with a fixed replacement word </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.IshObfuscator._longWordSubstitution"> <summary> To replace words > 20 chars .. a part of this very long word can be taken </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.ObfuscateXml(System.String,System.String,System.Collections.Generic.List{System.String})"> <summary> Obfuscates the given xml file. When the obfuscation succeeds a file is created at the location given in outputFileLocation </summary> <param name="inputFileLocation">The location of the input file</param> <param name="outputFileLocation">The location for the output file</param> <param name="attributesToObfuscate">Attributes to obfuscate</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.WriteXmlDeclaration(System.Text.Encoding,System.Xml.XmlReader,System.Xml.XmlWriter)"> <summary> Writes an xml declaration with the correct encoding </summary> <param name="encoding">Encoding</param> <param name="xmlReader">XmlReader positioned on a XmlDeclaration</param> <param name="xmlWriter">XmlWriter</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.ObfuscateWords(System.String)"> <summary> Substitutes the words in a phrase or paragraph with other (hardcoded) words </summary> <param name="text">Text to obfuscate</param> <returns> Obfuscated text </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.ObfuscateWord(System.String)"> <summary> Substitutes one word by another hardcoded word </summary> <param name="word">Word to obfuscate</param> <returns> Obfuscated word </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.ObfuscateImage(System.String,System.String)"> <summary> Obfuscates the given image file. For that, a new image is created with the same format, width and height and a yellow background (and the filename in text in the image if it is wide enough to put it there). When the obfuscation succeeds a file is created at the location given in outputFileLocation </summary> <param name="inputFileLocation">The location of the input file</param> <param name="outputFileLocation">The location for the output file</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.IshObfuscator.CreateImageWithText(System.String,System.Int32,System.Int32)"> <summary> Creates an image with the given width and height and having the given text </summary> <param name="text">Text to include in the image</param> <param name="width">Image width</param> <param name="height">Image height</param> <returns></returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NameHelper.GetPSNoteProperty(Trisoft.ISHRemote.Objects.Enumerations.ISHType[],Trisoft.ISHRemote.Objects.Public.IshMetadataField)"> <summary> Returns a PSNoteProperty (PSVariable doesn't allow sortable date) * Naming convention is lowercase using '=' as separator * Levels Lng, None, Task, Progress for ValueType Value are not part of the property name. All the rest is explicit Examples * e.g. DocumentObj... fauthor, fauthor=lng=value, fauthor=lng=element … modified-on, modified-on=lng=value, modified-on=ver=value, modified-on=log=value * e.g. User... level-None types… username, username=none=value, username=none=element * e.g. Events... not a card type… userid=progress=value </summary> <remarks>PSNoteProperty: date fields converting dd/MM/yyyy HH:mm:ss to a sortable format; so ISO8601 (ToString('s', dt)) yyyy'-'MM'-'dd'T'HH':'mm':'ss (similar format 'u' add time zone which I consider non-scope for now). Note that TranslationJob's LEASEDON is returned by the API in Utc.</remarks> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NameHelper.TryParseDateTimeExact(System.String,System.DateTime@)"> <summary> Single sourcing the fallback mechanism of historical API date formats used on the various CMS APIs This function should be used to avoid generic DateTime parsing based on environemnt variables that are different from classic dd/MM/yyyy. ([System.Globalization.CultureInfo]::CurrentCulture).DateTimeFormat.ShortDatePattern = "dd/MM/yyyy" </summary> <param name="someDateTimeValue">Incoming API potential DateTime string</param> <param name="outDateTime">DateTime object holding a succesful parse.</param> <returns></returns> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper"> <summary> Wraps a stream for all operations except Close and Dispose, which merely flush the stream and prevent further operations from being carried out using this wrapper. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.#ctor(System.IO.Stream)"> <summary> Creates a new instance of the class, wrapping the specified stream. </summary> <param name="stream">The stream to wrap. Must not be null.</param> <exception cref="T:System.ArgumentNullException">stream is null</exception> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.BaseStream"> <summary> Stream wrapped by this wrapper </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.closed"> <summary> Whether this stream has been closed or not </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.CheckClosed"> <summary> Throws an InvalidOperationException if the wrapper is closed. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"> <summary> Begins an asynchronous read operation. </summary> <param name="buffer">The buffer to read the data into. </param> <param name="offset"> The byte offset in buffer at which to begin writing data read from the stream. </param> <param name="count">The maximum number of bytes to read. </param> <param name="callback"> An optional asynchronous callback, to be called when the read is complete. </param> <param name="state"> A user-provided object that distinguishes this particular asynchronous read request from other requests. </param> <returns> An IAsyncResult that represents the asynchronous read, which could still be pending. </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"> <summary> Begins an asynchronous write operation. </summary> <param name="buffer">The buffer to write data from.</param> <param name="offset">The byte offset in buffer from which to begin writing.</param> <param name="count">The maximum number of bytes to write.</param> <param name="callback"> An optional asynchronous callback, to be called when the write is complete. </param> <param name="state"> A user-provided object that distinguishes this particular asynchronous write request from other requests. </param> <returns> An IAsyncResult that represents the asynchronous write, which could still be pending. </returns> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.CanRead"> <summary> Indicates whether or not the underlying stream can be read from. </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.CanSeek"> <summary> Indicates whether or not the underlying stream supports seeking. </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.CanWrite"> <summary> Indicates whether or not the underlying stream can be written to. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Close"> <summary> This method is not proxied to the underlying stream; instead, the wrapper is marked as unusable for other (non-close/Dispose) operations. The underlying stream is flushed if the wrapper wasn't closed before this call. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.EndRead(System.IAsyncResult)"> <summary> Waits for the pending asynchronous read to complete. </summary> <param name="asyncResult"> The reference to the pending asynchronous request to finish. </param> <returns> The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams only return zero (0) at the end of the stream, otherwise, they should block until at least one byte is available. </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.EndWrite(System.IAsyncResult)"> <summary> Ends an asynchronous write operation. </summary> <param name="asyncResult">A reference to the outstanding asynchronous I/O request.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Flush"> <summary> Flushes the underlying stream. </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Length"> <summary> Returns the length of the underlying stream. </summary> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Position"> <summary> Gets or sets the current position in the underlying stream. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Read(System.Byte[],System.Int32,System.Int32)"> <summary> Reads a sequence of bytes from the underlying stream and advances the position within the stream by the number of bytes read. </summary> <param name="buffer"> An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count- 1) replaced by the bytes read from the underlying source. </param> <param name="offset"> The zero-based byte offset in buffer at which to begin storing the data read from the underlying stream. </param> <param name="count"> The maximum number of bytes to be read from the underlying stream. </param> <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.ReadByte"> <summary> Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. </summary> <returns>The unsigned byte cast to an Int32, or -1 if at the end of the stream.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Seek(System.Int64,System.IO.SeekOrigin)"> <summary> Sets the position within the current stream. </summary> <param name="offset">A byte offset relative to the origin parameter.</param> <param name="origin"> A value of type SeekOrigin indicating the reference point used to obtain the new position. </param> <returns>The new position within the underlying stream.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.SetLength(System.Int64)"> <summary> Sets the length of the underlying stream. </summary> <param name="value">The desired length of the underlying stream in bytes.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.Write(System.Byte[],System.Int32,System.Int32)"> <summary> Writes a sequence of bytes to the underlying stream and advances the current position within the stream by the number of bytes written. </summary> <param name="buffer"> An array of bytes. This method copies count bytes from buffer to the underlying stream. </param> <param name="offset"> The zero-based byte offset in buffer at which to begin copying bytes to the underlying stream. </param> <param name="count">The number of bytes to be written to the underlying stream.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.NonClosingStreamWrapper.WriteByte(System.Byte)"> <summary> Writes a byte to the current position in the stream and advances the position within the stream by one byte. </summary> <param name="value">The byte to write to the stream. </param> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.StringEnum"> <summary> Helper class for working with 'extended' enums using <see cref="T:Trisoft.ISHRemote.HelperClasses.StringValueAttribute"/> attributes. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.#ctor(System.Type)"> <summary> Creates a new <see cref="T:Trisoft.ISHRemote.HelperClasses.StringEnum"/> instance. </summary> <param name="enumType">Enum type.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.GetStringValue(System.String)"> <summary> Gets the string value associated with the given enum value. </summary> <param name="valueName">Name of the enum value.</param> <returns>String Value</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.GetStringValues"> <summary> Gets the string values associated with the enum. </summary> <returns>String value array</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.GetListValues"> <summary> Gets the values as a 'bindable' list datasource. </summary> <returns>IList for data binding</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.IsStringDefined(System.String)"> <summary> Return the existence of the given string value within the enum. </summary> <param name="stringValue">String value.</param> <returns>Existence of the string value</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.IsStringDefined(System.String,System.Boolean)"> <summary> Return the existence of the given string value within the enum. </summary> <param name="stringValue">String value.</param> <param name="ignoreCase">Denotes whether to conduct a case-insensitive match on the supplied string value</param> <returns>Existence of the string value</returns> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.StringEnum.EnumType"> <summary> Gets the underlying enum type for this instance. </summary> <value></value> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.GetStringValue(System.Enum)"> <summary> Gets a string value for a particular enum value. </summary> <param name="value">Value.</param> <returns>String Value associated via a <see cref="T:Trisoft.ISHRemote.HelperClasses.StringValueAttribute"/> attribute, or null if not found.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.Parse(System.Type,System.String)"> <summary> Parses the supplied enum and string value to find an associated enum value (case sensitive). </summary> <param name="type">Type.</param> <param name="stringValue">String value.</param> <returns>Enum value associated with the string value, or null if not found.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.Parse(System.Type,System.String,System.Boolean)"> <summary> Parses the supplied enum and string value to find an associated enum value. </summary> <param name="type">Type.</param> <param name="stringValue">String value.</param> <param name="ignoreCase">Denotes whether to conduct a case-insensitive match on the supplied string value</param> <returns>Enum value associated with the string value, or null if not found.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.IsStringDefined(System.Type,System.String)"> <summary> Return the existence of the given string value within the enum. </summary> <param name="stringValue">String value.</param> <param name="enumType">Type of enum</param> <returns>Existence of the string value</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringEnum.IsStringDefined(System.Type,System.String,System.Boolean)"> <summary> Return the existence of the given string value within the enum. </summary> <param name="stringValue">String value.</param> <param name="enumType">Type of enum</param> <param name="ignoreCase">Denotes whether to conduct a case-insensitive match on the supplied string value</param> <returns>Existence of the string value</returns> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.StringValueAttribute"> <summary> Simple attribute class for storing String Values </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.StringValueAttribute.#ctor(System.String)"> <summary> Creates a new <see cref="T:Trisoft.ISHRemote.HelperClasses.StringValueAttribute"/> instance. </summary> <param name="value">Value.</param> </member> <member name="P:Trisoft.ISHRemote.HelperClasses.StringValueAttribute.Value"> <summary> Gets the value. </summary> <value></value> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper._logger"> <summary> Logger </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper._ishTypeFieldDefinitions"> <summary> Returning list of definitions </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper._cardTypeFieldElementNames"> <summary> cardTypeElementName and list of fieldElementNames </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper._fieldDefinitionElementNames"> <summary> fieldElementNames and FieldDefinition matching TriDKXmlSetup tridk:field </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper._xpathDocument"> <summary> Loaded TriDKXmlSetup Full Export </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper.FieldDefinition.#ctor(System.String,System.String,System.String,System.String,System.String,System.Int64,System.Int64,System.String,System.String,System.Collections.Generic.List{System.String})"> <summary> Private temporary container that initializes that custom fields are okay, system/standard fields will need correction later </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper.CorrectFieldDefinitions"> <summary> Correct FieldDefinitions with default on AllowOnCreate... so the other IshTypeFieldDefinition properties </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper.GenerateIshTypeFieldDefinitionsForCardTypesAndFields"> <summary> Combining CardTypeFieldDefinition defining the fields on a card type with FieldDefinitions, resulting in denormalized IshTypeFieldDefinitions </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.TriDKXmlSetupHelper.CorrectAllowOnSearch"> <summary> AllowOnSearch should be false everywhere, except on Content Objects, the only thing we put in our Full-Text-Index </summary> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog"> <summary> This class can resolve Public/System identifiers to one Uri DTD path and supports nextCatalog statements. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.UserReference"> <summary> Fixed user reference when logging </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.UserReferenceSeparator"> <summary> Fixed separator for the UserReference The UserReference is created by a combination of the UserReference and the ProcessId. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.CatalogNamespace"> <summary> Namespace of the OASIS catalog </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.CatalogPrefix"> <summary> Namespace prefix of the OASIS catalog </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.PublicIdAttribute"> <summary> Attribute with the PublicId </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.SystemIdAttribute"> <summary> Attribute with the SystemId </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.UriAttribute"> <summary> Attribute with the Uri </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.NextCatalogXPath"> <summary> XPath to find references to other catalogs (= NextCatalog) </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.PublicXPath"> <summary> XPath to find public defined DTDs </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.SystemXPath"> <summary> XPath to find DTDs that are defined with a SystemId </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.BaseUriXPath"> <summary> XPath to find the xml:base attribute starting from a specified XmlNode </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._publicIds"> <summary> Dictionary with the PublicIds. The key of the dictionary is the PublicId and the value is the absoluteUri. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._systemIds"> <summary> Dictionary with the SystemIds. The key of the dictionary is the SystemId and the value is the absoluteUri. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._nameSpaceManager"> <summary> XmlNamespaceManager stores the prefix and namespace of the OASIS catalog </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._xmlUrlResolver"> <summary> The XmlUrlResolver is internally used to append the relative uri with the base uri. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._catalogUri"> <summary> XMLCatalogFile in the TriDKApp of the current InfoShare project </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog._userReference"> <summary> User reference string (inclusive ProcessId) </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.#ctor(System.String)"> <summary> Initializes an instance of the XmlOASISCatalog with the given CatalogUri </summary> <param name="catalogUri">Filename (and path) of the XMLCatalogFile</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.ResolveSystemId(System.String)"> <summary> Returns the absolute Uri of the given SystemId. </summary> <param name="systemId">The SystemId</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.ResolvePublicId(System.String)"> <summary> Returns the absolute Uri of the given PublicId. </summary> <param name="publicId">The PublicId</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.TryResolveSystemId(System.String,System.String@)"> <summary> Returns whether a matching entry for the given systemId was found in the catalog </summary> <param name="systemId">The SystemId</param> <param name="resolvedSystemId">The systemId corresponding to the matching publicId entry in the catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.TryResolvePublicId(System.String,System.String@)"> <summary> Returns whether a matching entry for the given publicId was found in the catalog </summary> <param name="publicId">The PublicId</param> <param name="resolvedSystemId">The systemId corresponding to the matching publicId entry in the catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.ValidateUri(System.Uri)"> <summary> Determines whether the catalog URI is a base of the specified Uri instance, or whether the specified URI is defined in the catalog. </summary> <param name="uri">The specified URI to test.</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.ResolveNextCatalog(System.Xml.XmlDocument)"> <summary> Resolve references to other catalogs (= NextCatalog) and include the full catalog. This method results in one large catalog with all information. </summary> <param name="catalog">The main catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.InsertNextCatalog(System.Xml.XmlDocument,System.Xml.XmlDocument,System.Xml.XmlNode)"> <summary> Insert all child nodes of the NextCatalog after the reference node. </summary> <param name="catalog">The current Catalog</param> <param name="nextCatalog">The NextCatalog</param> <param name="refNode">The reference node</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.GetNextCatalog(System.Xml.XmlNode)"> <summary> Load the XML document of the referenced catalog </summary> <param name="nextCatalogNode">NextCatalog node</param> <returns>XML document with the NextCatalog</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.GetBaseUri(System.Xml.XmlNode)"> <summary> Return the xml:base attribute in the catalog. First try to find the BaseUri attribute on the start node. If there is no BaseUri attribute on the start node, try to find the attribute on the ancestor nodes. </summary> <param name="node">Start node</param> <returns> BaseUri of the catalog. When no xml:base attribute is specified, null is returned. </returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.LoadPublicIds(System.Xml.XmlNode)"> <summary> Initialize the dictionary with all PublicIds and their AbsoluteUri from the complete catalog </summary> <param name="catalog">XML document with the catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.LoadSystemIds(System.Xml.XmlNode)"> <summary> Initialize the dictionary with all SystemIds and their AbsoluteUri from the complete catalog </summary> <param name="catalog">XML document with the catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlOASISCatalog.Normalize(System.String)"> <summary> To normalize the given FilePath by creating a Uri and returning the AbsoluteUri. When the normalization fails, the FilePath is returned. </summary> <param name="filePath">A FilePath</param> </member> <member name="T:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog"> <summary> XmlResolver that uses the XMLOASISCatalog to resolve the location of DTDs. </summary> </member> <member name="F:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog._xmlOASISCatalog"> <summary> The XmlOASISCatalog is used to resolve Public/System identifiers to one Uri DTD path </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog.#ctor"> <summary> Initialize an instance of the XmlResolverUsingCatalog. </summary> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog.#ctor(System.String)"> <summary> Initialize an instance of the XmlResolverUsingCatalog. This also involves the creation of a XmlOASISCatalog. </summary> <param name="catalogUri">Filename (and path) of the XMLCatalogFile</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog.ResolveUri(System.Uri,System.String)"> <summary> This method overrides the ResolveUri of the XmlResolver. <seealso cref="M:System.Xml.XmlResolver.ResolveUri(System.Uri,System.String)"/> The method uses the XmlOASISCatalog to resolve the absolute URI from the base and relative URIs. </summary> <param name="baseUri">The base URI used to resolve the relative URI</param> <param name="relativeUri">The URI to resolve. The URI can be absolute or relative.</param> <returns>A Uri representing the absolute URI or a null reference if the relative URI cannot be resolved.</returns> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog.TryResolveDTDPublicId(System.String,System.String@)"> <summary> Returns whether a matching entry for the given publicId was found in the catalog </summary> <param name="publicId">The PublicId</param> <param name="resolvedSystemId">The systemId corresponding to the matching publicId entry in the catalog</param> </member> <member name="M:Trisoft.ISHRemote.HelperClasses.XmlResolverUsingCatalog.TryResolveDTDSystemId(System.String,System.String@)"> <summary> Returns whether a matching entry for the given systemId was found in the catalog </summary> <param name="systemId">The SystemId</param> <param name="resolvedSystemId">The systemId corresponding to the matching publicId entry in the catalog</param> </member> <member name="T:Trisoft.ISHRemote.Interfaces.ILogger"> <summary> Represents logging functionality. </summary> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteVerbose(System.String)"> <summary> Writes verbose message. </summary> <param name="message">Verbose message.</param> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteProgress(System.String,System.String,System.Int32)"> <summary> Reports progress. </summary> <param name="activity">Activity that takes place.</param> <param name="statusDescription">Activity description.</param> <param name="percentComplete">Complete progress in percent equivalent.</param> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteParentProgress(System.String,System.String,System.Int32)"> <summary> Reports parent progress. </summary> <param name="activity">Activity that takes place.</param> <param name="statusDescription">Activity description.</param> <param name="percentComplete">Complete progress in percent equivalent.</param> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteDebug(System.String)"> <summary> Writes debug-useful information. </summary> <param name="message">Debug message.</param> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteWarning(System.String)"> <summary> Writes warning message. </summary> <param name="message">Warning message.</param> </member> <member name="M:Trisoft.ISHRemote.Interfaces.ILogger.WriteError(System.Exception,System.Object)"> <summary> Writes non-terminating error. </summary> <param name="ex">Exception as a result of the error.</param> <param name="errorObject">Object that caused error.</param> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations"> <summary> <para type="description">Contains all enumerations and conversion required for this client library</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.Protocol"> <summary> <para type="description">IshSession Protocol tries to connect the communication protocol like ASMX (Soap11), WCF (Soap12), OpenAPI (rest) with the authentication protocol like WS-Trust (WCF-only), AuthenticationContext (Asxm-only), etc. Offering shorthand for working combinations.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.Protocol.Autodetect"> <summary> <para type="description">Will try to find the best match, most likely based on the target systems software version.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.Protocol.WcfSoapWithWsTrust"> <summary> <para type="description">Wcf (Soap12) endpoints exist since InfoShare 10.0.0, always authenticated over WS-Federation/WS-Trust which works for internal and external user profiles.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.Protocol.WcfSoapWithOpenIdConnect"> <summary> <para type="description">Wcf (Soap12) endpoints exist since InfoShare 15.0.0 as public Api, always authenticated over OpenIDConnect/OAuth20 which works for internal and external user profiles.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.Protocol.OpenApiWithOpenIdConnect"> <summary> <para type="description">OpenApi (rest) endpoints exist since InfoShare 15.0.0 as private Api, always authenticated over OpenIDConnect/OAuth20 which works for internal and external user profiles.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.Level"> <summary> <para type="description">Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ValueType"> <summary> <para type="description">Which data type to retrieve from the database for the specified field</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ValueType.Value"> <summary> The value of the ishfield. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ValueType.Element"> <summary> The GUID of the ishfield. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ValueType.Id"> <summary> The Id of the ishfield. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ValueType.All"> <summary> All is used when the valuetype is irrelevant. For example when a field needs to be removed and you do not want to loop all different value types. </summary> TODO [Should] IshTypeFieldSetup - Remove confuzing value 'All' for ValueType usage, can be done once IshSession.IshTypeFieldSetup is implemented (see [ISHREMOTE-017]) </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.StrictMetadataPreference"> <summary> <para type="description">Allows tuning client-side metadata handling/warning since the IshTypeFieldSetup introduction.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StrictMetadataPreference.SilentlyContinue"> <summary> Client-side silent filtering of nonexisting and unallowed fields. (e.g Nice for repository folder syncing with mismatching metadata setup) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StrictMetadataPreference.Continue"> <summary> Client-side filtering of nonexisting and unallowed fields displaying a Write-Verbose message but still continues. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StrictMetadataPreference.Off"> <summary> Client-side filtering of nonexisting and unallowed fields is turned off. No handling but simply executes the API call, most likely resulting in a Write-Error. This allows api/pester tests like IshUser PASSWORD field should not allowed to be read. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.PipelineObjectPreference"> <summary> <para type="description">Allows tuning client-side object enrichment like no wrapping (off) or PSObject-with-PSNoteProperty wrapping.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.PipelineObjectPreference.PSObjectNoteProperty"> <summary> Wrap every possible pipeline object with PSObject and add PSNoteProperty for all IshFields </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.PipelineObjectPreference.Off"> <summary> Deprecated legacy behavior (0.6 and earlier), so no pipeline PSObject wrapping </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.RequestedMetadataGroup.Descriptive"> <summary> performance-optimized, only primary keys </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.RequestedMetadataGroup.Basic"> <summary> user friendly fields used in tables </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.RequestedMetadataGroup.All"> <summary> not performant </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ActivityFilter"> <summary> <para type="description">List of value like Events can be hidden upon Find/Retrieval with these filters</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.FilterOperator"> <summary> <para type="description">When filtering information having certain value(s), you need operators per field</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ValueAction"> <summary> <para type="description">If two fields should be first, should the second value overwrite the first or prepend/append it</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ActionMode"> <summary> <para type="description">Used by RemoveSystemFields to know which fields to filter. E.g. at creation time of a user PASSWORD is allowed, but not at retrieval time.</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ReferenceType"> <summary> <para type="description">Used by IshObject/IshEvent/IshBackgroundTask to set all reference types on a card</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ISHType"> <summary> <para type="description">Enumeration of all possible object types.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHNone"> <summary> Initial value...we don't know what the ISHType is. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHNotFound"> <summary> The object does not exists </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHModule"> <summary> InfoShare Module/IMAP-Map/DITA-Topic </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHMasterDoc"> <summary> InfoShare MasterDocument/IMAP-Master/DITA-(Book)Map/DocumentOutline </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHLibrary"> <summary> InfoShare Library </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHTemplate"> <summary> InfoShare Template </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHIllustration"> <summary> InfoShare Illustration/Image/Graphic </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHPublication"> <summary> InfoShare publication object </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHUser"> <summary> InfoShare user </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHUserGroup"> <summary> InfoShare usergroup (new name for department) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHUserRole"> <summary> InfoShare user role </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHBaseline"> <summary> The baseline </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHOutputFormat"> <summary> InfoShare output format object </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHEDT"> <summary> Electronic Document Type </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHFolder"> <summary> Folder/Directory </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHTranslationJob"> <summary> Translation job </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHConfiguration"> <summary> Configuration card </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHRevision"> <summary> Electronic document/ED/Revision </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHFeatures"> <summary> Conditional Context, available on FISHCONTEXT (used to be saved on CTCONTEXT card type) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHBackgroundTask"> <summary> Background Task table </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHEvent"> <summary> Event Monitor table </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHAnnotation"> <summary> Annotations </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ISHType.ISHProject"> <summary> Projects </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType"> <summary> <para type="description">Enumeration of folder types.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHNone"> <summary> In this folder no objects allowed except subfolders </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHModule"> <summary> Folder with InfoShare Module/IMAP-Map/DITA-Topic </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHMasterDoc"> <summary> Folder with InfoShare MasterDocument/IMAP-Master/DITA-(Book)Map/DocumentOutline </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHLibrary"> <summary> Folder with InfoShare Library </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHTemplate"> <summary> Folder with InfoShare Template </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHIllustration"> <summary> Folder with InfoShare Illustration/Image/Graphic </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHPublication"> <summary> Folder with InfoShare publication object </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHReference"> <summary> Folder with Document references </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.IshFolderType.ISHQuery"> <summary> Query Folders </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.DataType"> <summary> /// <para type="description">Enumerations for controlled date types, used by IshTypeFieldDefinition. Holding base types like number, long, etc</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.ISHLov"> <summary> The field data type is a reference field pointing to a List Of Values (DOMAIN) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.ISHType"> <summary> The field data type is a reference field pointing to another ISHType (CARD REFERENCE) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.String"> <summary> The field data type is a simple text type, preferred for shorting string values with the most API operators </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.LongText"> <summary> The field data type is a simple text type, preferred for longer string values with less API operators (only empty/notempty) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.Number"> <summary> The field data type is a simple controlled decimal type </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.DateTime"> <summary> The field data type is a simple controlled date time type </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.DataType.ISHMetadataBinding"> <summary> The field data type used to describe metadata bound fields </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.BaseFolder"> <summary> <para type="description">Enumerations of basefolders</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BaseFolder.Data"> <summary> Indicates the Data folder as starting point. Also known as 'General', 'ISREPROOT', normal repository content,... </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BaseFolder.System"> <summary> Indicates the System folder as starting point </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BaseFolder.Favorites"> <summary> Indicates the User's favorite folder as starting point </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BaseFolder.EditorTemplate"> <summary> Indicates the 'Editor Template' folder as starting point </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.StatusFilter"> <summary> <para type="description">Enumeration matching the API status filters for IshObjects</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StatusFilter.ISHReleasedStates"> <summary> Released states only </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StatusFilter.ISHReleasedOrDraftStates"> <summary> Released or Draft states </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StatusFilter.ISHOutOfDateOrReleasedStates"> <summary> Out of date or Released states </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.StatusFilter.ISHNoStatusFilter"> <summary> No status filter </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter"> <summary> <para type="description">BackgroundTask Status Filter</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter.Busy"> <summary> Filtering on the status Busy will return all with status: VBACKGROUNDTASKSTATUSEXECUTING, VBACKGROUNDTASKSTATUSPENDING </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter.Success"> <summary> Filtering on the status Success will return all with status: VBACKGROUNDTASKSTATUSSUCCESS, VBACKGROUNDTASKSTATUSSKIPPED </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter.Failed"> <summary> Filtering on the status Failed will return all with status: VBACKGROUNDTASKSTATUSFAILED, VBACKGROUNDTASKSTATUSABORTED (NotUsedIn-13.0.1), VBACKGROUNDTASKSTATUSCANCELPENDING (NotUsedIn-13.0.1), VBACKGROUNDTASKSTATUSCANCELLED (NotUsedIn-13.0.1) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.BackgroundTaskStatusFilter.All"> <summary> No filtering on the status is applied </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter"> <summary> <para type="description">EventMonitor Events Status Filter</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter.Busy"> <summary> Filtering on the status Busy will return all events which are still busy </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter.Success"> <summary> Filtering on the status Success will return all events which are completed successfully </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter.Warning"> <summary> Filtering on the status Success will return all events with warnings </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter.Failed"> <summary> Filtering on the status Failed will return all failed events </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.ProgressStatusFilter.All"> <summary> No filtering on the status is applied </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.UserFilter"> <summary> <para type="description">EventMonitor Events User Filter</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.UserFilter.Current"> <summary> Used to indicate that only the events of the current user should be returned </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.UserFilter.All"> <summary> Used to indicate that all events should be returned </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.EventLevel"> <summary> <para type="description">Possible values for the level of an event detail</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Exception"> <summary> Indicates that the event detail contains an error </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Warning"> <summary> Indicates that the event detail contains a noncritical problem </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Configuration"> <summary> Indicates that the event detail contains a configuration message </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Information"> <summary> Indicates that the event detail contains an informational message </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Verbose"> <summary> Indicates that the event detail contains a verbose message </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Enumerations.EventLevel.Debug"> <summary> Indicates that the event detail contains a debug message </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.BaselineSourceEnumeration"> <summary> <para type="description">Possible values for the source enumeration of a baseline entry</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Enumerations.InputDataTemplate"> <summary> <para type="description">The InputDataTemplate (e.g. IshObjectWithLngRef) indicates whether a list of ishObjects or one ishObject is submitted as input data to the background task.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Enumerations.Key(Trisoft.ISHRemote.Objects.Enumerations.ISHType,Trisoft.ISHRemote.Objects.Enumerations.Level,System.String)"> <summary> Unique descriptive identifier of an IshTypeFieldDefinition concatenating type, level (respecting log/version/lng), and field name </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Enumerations.ToLevelFromCardType(System.String)"> <summary> Extracts the TriDK CardType level from input like USER, CTMAPL,... </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Enumerations.ToIshTypeFromCardType(System.String)"> <summary> Extracts the TriDK CardType type from input like USER, CTMAPL,... </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Enumerations.ToBaselineSourceEnumeration(System.String)"> <summary> Extracts the baseline source enumeration </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Enumerations.ToDDOCTYPEValue(Trisoft.ISHRemote.Objects.Enumerations.IshFolderType)"> <summary> OpenApi (dd 20211228) expects DDOCTYPE value instead of more generic enumeration of folder types. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.FieldElements"> <summary> FieldElements groups all constants to access the fields with an element. Duplication of \Dev\Server.App\Common\Trisoft.InfoShare\Trisoft.InfoShare.Configuration\Common\FieldElements.cs </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Name"> <summary> The element of the Field NAME. This mandatory field contains the label of the card. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.CreationDate"> <summary> The element of the Field CREATED-ON </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ModificationDate"> <summary> The element of the Field MODIFIED-ON </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.CardType"> <summary> The element of the Field CARD-TYPE. This mandatory field contains an LovValue with the CardType of the card. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Ancestor"> <summary> The element of the field FANCESTOR </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.MapId"> <summary> The element of the field FMAPID Used on language objects to store the LogicalId </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ObjectActive"> <summary> The element of the field FISHOBJECTACTIVE Used on cardtypes which are linked with an LOV (e.g. CTOUTPUTFORMAT, USER, CTUSERROLE and CTUSERGROUP) to allow hiding or showing values in the UI. Note that the value is still valid input. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReadAccess"> <summary> The element of the Field READ-ACCESS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ModifyAccess"> <summary> The element of the Field MODIFY-ACCESS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DeleteAccess"> <summary> The element of the Field DELETE-ACCESS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Owner"> <summary> The element of the Field OWNER </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Rights"> <summary> The element of the Field RIGHTS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Usergroup"> <summary> The element of the Field FUSERGROUP </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserName"> <summary> The element of the Field USERNAME </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserDisplayName"> <summary> The element of the Field FISHUSERDISPLAYNAME </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Password"> <summary> The element of the Field PASSWORD </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserRoles"> <summary> The element of the Field FISHUSERROLES (new element name of FISHCAPABILITIES) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserLanguage"> <summary> The element of the Field FISHUSERLANGUAGE </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Favorites"> <summary> The element of the Field FISHFAVORITES This field contains the folder card with the 'favorite' objects </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserType"> <summary> The element of the Field FISHUSERTYPE </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ExternalId"> <summary> The element of the Field FISHEXTERNALID This field maps an external authenticated user to a Trisoft user </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserDisabled"> <summary> The element of the Field FISHUSERDISABLED A disabled user is no longer allowed to log in. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserPasswordSalt"> <summary> The element of the Field FISHPASSWORDSALT Used on USER to store the password salt </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserPasswordModifiedOn"> <summary> The element of the Field FISHPASSWORDMODIFIEDON Used on USER to store the date when the password was last modified </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserLastLoginOn"> <summary> The element of the Field FISHLASTLOGINON Used on USER to store the date on when user last log in </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserFailedAttempts"> <summary> The element of the Field FISHFAILEDATTEMPTS Used on USER to store the count of failed attemtps </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserLockedSince"> <summary> The element of the Field FISHLOCKEDSINCE Used on USER to store the date since when the account had been locked </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserLocked"> <summary> The element of the Field FISHLOCKED Used on USER to store the account locked status </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserPasswordHistory"> <summary> The element of the Field FISHPASSWORDHISTORY Used on USER to store the password history </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserGroupName"> <summary> The element of the Field FISHUSERGROUPNAME Used on usergroups to link the card with the LovValue of DUSERGROUP which contains the label/name of the usergroup </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.UserRoleName"> <summary> The element of the Field FISHUSERROLENAME Used on userroles to link the card with the LovValue of DUSERROLE which contains the label/name of the userrole </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.StatusConfiguration"> <summary> The element of the Field FSTATECONFIGURATION Used on Configuration Card to store the active status configuration containing the status definitions, status transitions and initial statuses. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationStatusConfiguration"> <summary> The element of the Field FISHPUBSTATECONFIG Used on Configuration Card to store the publication status configuration containing the different status definitions and transitions of the publication. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationConfiguration"> <summary> The element of the Field FTRANSLATIONCONFIGURATION Used on Configuration Card to store the active translation configuration </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.InboxConfiguration"> <summary> The element of the Field FINBOXCONFIGURATION Used on Configuration Card to store the inbox configuration xml </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PluginConfiguration"> <summary> The element of the Field FISHPLUGINCONFIGXML Used on Configuration Card to store the active plugin/OnDocStore configuration. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ChangeTrackerConfiguration"> <summary> The element of the Field FISHCHANGETRACKERCONFIG This field contains the Changetracker configuration, used when publishing or previewing the changes between the content of 2 objects. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobStatusConfiguration"> <summary> The element of the Field FISHTRANSJOBSTATECONFIG Used on Configuration Card to store the translation job status configuration containing the different status definitions and transitions of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.WritePluginConfiguration"> <summary> The element of the Field FISHPLUGINCONFIGXML Used on Configuration Card to store the active plugin/OnDocStore configuration. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishPluginConfiguration"> <summary> The element of the Field FISHPUBLISHPLUGINCONFIG Used on Configuration Card to store the active publish plugin configuration. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BackgroundTaskConfiguration"> <summary> The element of the Field FISHBACKGROUNDTASKCONFIG Used on Configuration Card to store the configuration for the background tasks. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ExtensionConfiguration"> <summary> The element of the Field FISHEXTENSIONCONFIG Used on Configuration Card to store the configuration for the extensions. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.LiveContentReachUri"> <summary> The element of the Field FISHLCURI Used to link Architect with Reach systems </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.LiveContentEnrichUri"> <summary> The element of the Field FISHENRICHURI Used to link Architect with Enrich systems </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.SystemResolution"> <summary> The element of the Field FISHSYSTEMRESOLUTION. The system wide default resolution. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Page"> <summary> The element of the Field that links the blob/page with the ED/Document Card </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EDTName"> <summary> The element of the Field FISHEDTNAME. This field links the EDT card with the corresponding LovValue. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EDMimeType"> <summary> The element of the Field that indicates the mimetype of the document </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EDFileExtension"> <summary> The element of the Field that indicates the file extension of the document </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EDTCandidate"> <summary> The element of the Field that contains the possible file extensions for the EDT </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EDType"> <summary> The element of the Field EDT </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BaselineReleased"> <summary> The element of the Field FISHLABELRELEASED. This field indicates that the baseline is released/frozen or not. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BaselineActive"> <summary> The element of the Field FISHBASELINEACTIVE. This field indicates that the baseline is active or not. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BaselineLovValue"> <summary> The element of the Field FISHDOCUMENTRELEASE. This field links the baseline card with the corresponding LovValue. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BaselineName"> <summary> The element of the Field FISHDOCUMENTRELEASE. This field links the baseline card with the corresponding LovValue which contains the label of the baseline. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatName"> <summary> The element of the Field FISHOUTPUTFORMATNAME. This field links the OutputFormat card with the corresponding LovValue. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatResolutions"> <summary> The element of the Field FISHRESOLUTIONS. The resolutions that can be used for this OutputFormat (only these resolutions are exported in the Publish) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatSingleFile"> <summary> The element of the Field FISHSINGLEFILE. Used on the OutputFormat to indicate if the output is one file or not. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatCleanup"> <summary> The element of the Field FISHCLEANUP. Used on the OutputFormat to indicate if working files must be removed after publishing. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatKeepDTDSystemId"> <summary> The element of the Field FISHKEEPDTDSYSTEMID. Used on the OutputFormat to indicate if the resulting files must have SystemIds for the DTD </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputEDType"> <summary> The element of the Field FISHOUTPUTEDT. Used on the OutputFormat to indicate the EDT of the output </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DitaDeliveryClientSecret"> <summary> The element of the Field FISHDITADLVRCLIENTSECRET. The client secret used for oAuth authentication to connect to Dita Delivery services. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Revisions"> <summary> The element of the field FISHREVISIONS Used on language objects to store the list with the revision objects </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.RevisionCounter"> <summary> The element of the field FISHREVCOUNTER Used on language objects to store the sequence of the last revision </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.RevisionLog"> <summary> The element of the field FISHREVISIONLOG Used on language objects to store the XML with the information of the revisions (CreationDate, Author and status of a new revision) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.RevisionHistoryLogging"> <summary> The element of the field FHISTORYLOGGING [deprecated] Used on various language card types to store the historic status transition information. Since InfoShare 3.3.x this way of storing information is replaced by FISHREVISIONLOG. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Title"> <summary> The element of the field FTITLE </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Description"> <summary> The element of the field FDESCRIPTION </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DisableRevisions"> <summary> The element of the field FISHNOREVISIONS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DocVersionMultiLng"> <summary> The element of the field DOC-VERSION-MULTI-LNG This field links the logical level with the version level of an object. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.SavedContexts"> <summary> The element of the field FISHCONTEXTS Used on CTMASTER and CTPUBLICATIONV to list the saved CTCONTEXTs. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EditorTemplateIconName"> <summary> The element of the field FISHEDITTMPLTICONNAME. Used for serving the icon of an editor template in the web </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.RequestedLanguages"> <summary> The element of the Field FREQUESTEDLANGUAGES. Used on various logical card types to store the languages that are requested for this object, matching values from DLANGUAGE. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.InheritedLanguages"> <summary> The element of the Field FINHERITEDLANGUAGES. Used on various logical card types to store the languages which are indicated as requested languages by objects holding a reference to this object at the time Translation Management was executed. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DisableTranslationManagement"> <summary> The element of the Field FNOTRANSLATIONMGMT. Used on various logical card types to indicate if TranslationManagement is activated or not </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Version"> <summary> The element of the field VERSION </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BranchNumber"> <summary> The element of the field FISHBRANCHNR </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.LngVersion"> <summary> The element of the field LNG-VERSION This field links the version level with the language level of an object. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.CandidateForBaseline"> <summary> The element of the field FISHRELEASECANDIDATE. This field indicates that the current version object is a candidate for the specified baseline </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReferencedFrozenBaselines"> <summary> The element of the field FISHRELEASELABEL. Used on various version card types to store a reference to a CTBASELINE that this particular version is part of the referenced frozen baseline. When freezing a baseline, this field is set automatically. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReusedInVersion"> <summary> The element of the field FREUSEDINVERSION. Used on various version card types to store a lists of pairs of block id and reusable object sequence number of all start reuse operations that occurred on this version. For example "warning-id-06£360" means that start reuse on element with id “warning-id-06” resulted in the creation of reusable object with logical id "IS_REUSED_OBJECT_360". </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.DocumentLanguage"> <summary> The element of the field DOC-LANGUAGE </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.SourceLanguage"> <summary> The element of the field FSOURCELANGUAGE </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Resolution"> <summary> The element of the field FRESOLUTION </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.StatusType"> <summary> The element of the field FISHSTATUSTYPE. This field contains the mapping of the FISHSTATUS / FISHPUBSTATUS with its enum values: DrafT(10), Release Candidate(15), Released(20), ... </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Status"> <summary> The element of the field FSTATUS. Used on various language card types to store the current status, matching a value from DSTATUS. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.LastModifiedBy"> <summary> The element of the field FISHLASTMODIFIEDBY. Used on various language card types to automatically store the user which has done the last modification to the document </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.LastModifiedOn"> <summary> The element of the field FISHLASTMODIFIEDON. Used on various language card types to automatically store the modification date indicating the last modification to the document </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Conditions"> <summary> The element of the field FISHCONDITIONS. Used on various language card types to store the condition name:value pairs present in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.SuccessfulPlugins"> <summary> The element of the field FISHPLUGINS. Used on various language card types to store the succesfully ran plugins. Can be used by status transitions to verify if a plugin was ran succesfully (eg. valid xml) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReusableObjectSystemLock"> <summary> The element of the field FSYSTEMLOCK. Used on various language card types to indicate that an asynchrone/background process is triggered to generate a reusable object. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationManagementStartDate"> <summary> The element of the field FTRANSLSTARTDATE. Used on various language card types to indicate that Translation Management is started on this language. Translation Management will in background set the current date automatically in this field. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.WordCount"> <summary> The element of the field FISHWORDCOUNT. Used on various language card types to store the total number of words using space as delimiter in the current language attached xml file. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationLoad"> <summary> The element of the field FISHTRANSLATIONLOAD. Used on various language card types to store the number of untranslated words (excluding words within preTranslation elements) using the space as delimiter in the current language attached xml file. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ToBeTranslatedWordCount"> <summary> The element of the field FISHTOBETRANSLWC. Used on various language card types to store the number of untranslated words (excluding words within preTranslation elements) using the space as delimiter in the current language attached xml file. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.EditorTemplateDescription"> <summary> The element of the field FISHEDITTMPLTDESCRIPTION. Used for serving the description of an editor template in the web </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Thumbnail"> <summary> The element of the field FISHTHUMBNAIL. Holds a reference on the logical level to the latest version ED card holding the Thumbnail Image data </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ImageLinks"> <summary> The element of the Field FISHIMAGELINKS. Used on various language card types to store the illustration references present in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Links"> <summary> The element of the Field FISHLINKS. Used on various language card types to store the object references (includes links and conref without anchor) present in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.HyperLinks"> <summary> The element of the field FISHHYPERLINKS. Used on various language card types to store the hyperlink references present in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReusableObjects"> <summary> The element of the field FISHREUSABLEOBJECTS </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.VariableAssignments"> <summary> The element of the field FISHVARASSIGNED Used on various language card types to store all variable assignments in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.VariablesInUse"> <summary> The element of the field FISHVARINUSE Used on various language card types to store all variables that are used in the attached document. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Targets"> <summary> The element of the field FISHTARGETS Used on various language card types to store possible anchors in the attached document that can be used as a target for a document fragment link (eg. conref, hyperlink). </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FragmentLinks"> <summary> The element of the field FISHFRAGMENTLINKS Used on various language card types to store the full document fragment references used in the attached document (eg. conref including anchor). </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ConRefs"> <summary> The element of the ConRefs (see FragmentLinks) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ED"> <summary> The element of the field ED </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.CheckedOut"> <summary> The element of the field CHECKED-OUT. Used on CTCONTEXT, CTBASELINE and all language level cards to store a boolean indicating whether the object is checked out or not. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.CheckedOutBy"> <summary> The element of the field CHECKED-OUT-BY. Used on CTCONTEXT, CTBASELINE and all language level cards to store the reference to the USER card indicated as user who checked out this object. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Baseline"> <summary> The element of the field FISHBASELINE. This field links the version level of the Publication with the baseline card. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.MasterReference"> <summary> The element of the field FISHMASTERREF. This field contains the master for this version level of the Publication </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Resources"> <summary> The element of the field FISHRESOURCES. This field contains the resources for this version level of the Publication </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationSourceLanguages"> <summary> The element of the field FISHPUBSOURCELANGUAGES. This field contains the (required) source language(s) for this version level of the Publication </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.RequiredResolutions"> <summary> The element of the field FISHREQUIREDRESOLUTIONS. This field contains the required resolution(s) for this version level of the Publication </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationContext"> <summary> The element of the field FISHPUBCONTEXT. This field contains the context for this version level of the Publication </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationReleased"> <summary> The element of the field FISHISRELEASED. This field indicates if this version of the Publication is released or not. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationModifiedOn"> <summary> The element of the field FISHMODIFIEDON. This field indicates when this version of the Publication was modified. The version of the Publication is modified, when the baseline or publication context is changed. The version of the Publication is NOT modified, when an extra Publication Output is added. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BaselineCompleteMode"> <summary> The element of the field FISHBASELINECOMPLETEMODE. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationLanguageCombination"> <summary> The element of the field FISHPUBLNGCOMBINATION. Used on the PublicationOutput to indicate the language combination of the publicaiton output </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.OutputFormatReference"> <summary> The element of the field FISHOUTPUTFORMATREF. This field links the PublicationOutput with the OutputFormat card. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublicationOutputStatus"> <summary> The element of the field FISHPUBSTATUS. Used on the publication version to store the current publication status, matching a value from DPUBSTATUS. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishEventId"> <summary> The element of the field FISHEVENTID. Unique identifier of the event that was started to run this publication. If it is empty, there is no publication attached yet, or the publication has been reset. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.Publisher"> <summary> The element of the field FISHPUBLISHER. The user that published this publication. Contains a reference to an user. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishStartDate"> <summary> The element of the field FISHPUBSTARTDATE. Used on the publication language to indicate the start date of the publication process. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishEndDate"> <summary> The element of the field FISHPUBENDDATE. Used on the publication language to indicate the end date of the publication process. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishReport"> <summary> The element of the field FISHPUBREPORT. The publication report contains information or messages that where logged during the publication process. E.g. It will contain the reason why the publication was draft or why it failed. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.JobSpecificationDestination"> <summary> The element of the field FISHJOBSPECDESTINATION. Used on PublicationOutput and links with system LOV DJOBSPECDESTINATION. It contains Output destination values Watch and OnHold. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.ReviewEndDate"> <summary> The element of the field FISHPUBREVIEWENDDATE DateTime field which specifies an end date for reviewing. An empty value means the review time is infinite. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishIncludeComments"> <summary> The element of the field FPUBINCLUDECOMMENTS Publication language setting that allows XML comments to be included as part of a publication. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishIncludeMetadata"> <summary> The element of the field FPUBINCLUDEMETADATA Publication language setting that allows metadata to be included as part of a publication. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishWaterMark"> <summary> The element of the field FPUBWATERMARK Publication language setting that allows a string to be displayed as watermark as part of a publication. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishDocumentFallbackLanguages"> <summary> The element of the field FISHFALLBACKLNGDEFAULT Publish fallback languages for documents </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishImagesFallbackLanguages"> <summary> The element of the field FISHFALLBACKLNGIMAGES Publish fallback languages for images </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.PublishResourcesFallbackLanguages"> <summary> The element of the field FISHFALLBACKLNGRESOURCES Publish fallback languages for resources </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderContents"> <summary> The element of the field FDOCUMENTS Used on CTDOCMAP to store the list of logical cards available in this folder. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderContentType"> <summary> The element of the field FDOCUMENTTYPE Used on CTDOCMAP to indicate which type of objects can be stored in this folder. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderSubFolders"> <summary> The element of the field FFOLDERS Used on CTDOCMAP to store the list of all subfolders of this folder. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderContentReferences"> <summary> The element of the field FISHDOCUMENTREFERENCES Used on CTDOCMAP for folders of the type "Reference" to store the shortcuts to chosen logical cards (eg. My Favorites). </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderContentQuery"> <summary> The element of the field FISHQUERY Used on CTFOLDER for folders of the type "Query" to store the FolderQuery XML structure containing the metadata query to find the content of this folder. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderName"> <summary> The element of the field FNAME Used on CTDOCMAP to store the name of the folder </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderOwner"> <summary> Reference to the user that created/ owned the objects --> The owner of the Folder is stored in the FUSERGROUP </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.FolderPath"> <summary> The element of the field FISHFOLDERPATH Used on CTDOCMAP to store the folder path on the folders </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobName"> <summary> The element of the Field FNAME. The name of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobStatus"> <summary> The element of the Field FISHTRANSJOBSTATUS. The status of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobSentOutBy"> <summary> The element of the Field FISHTRANSJOBSENTOUTBY. The user who sent out the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobSourceLanguage"> <summary> The element of the Field FISHTRANSJOBSRCLNG. The source language of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobTemplateId"> <summary> The element of the Field FISHTRANSJOBTRANSTEMPLID. The id of the template used in the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobRequiredDate"> <summary> The element of the Field FISHTRANSJOBREQUIREDDATE. The required date of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobIncludeTranslated"> <summary> The element of the Field FISHTRANSJOBINCLTRANSLTD. Specifies whether the translation job should include already translated items. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobTargetFields"> <summary> The element of the Field FISHTRANSJOBTARGETFIELDS. The target fields of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobProgressId"> <summary> The element of the Field FISHTRANSJOBPROGRESSID. The id of the event in the event monitor related to the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobPushTranslationProgressIds"> <summary> The element of the Field FISHPUSHTRANSPROGRESSIDS. The id of the event in the event monitor related to the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobType"> <summary> The element of the Field FISHTRANSJOBTYPE. The type of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobDescription"> <summary> The element of the Field FDESCRIPTION. The description of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobOwner"> <summary> Reference to the user that created/ owned the objects --> The owner of the TranslationJob is stored in the FUSERGROUP </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobLeasedBy"> <summary> The element of the Field FISHLEASEDBY. The id of the processing step which is currently processing the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobLeasedOn"> <summary> The element of the Field FISHLEASEDON. The date and the time when the FISHLEASEDBY field was last changed. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobAlias"> <summary> The element of the Field FISHTRANSJOBALIAS. The alias of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.TranslationJobLeases"> <summary> The element of the Field FISHTRANSJOBLEASES. The leases of the translation job. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationCreator"> <summary> The element of the Field FISHANNOTATIONCREATOR. The creator of annotation or reply on the annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationReplies"> <summary> The element of the Field FISHANNOTATIONREPLIES. The replies of annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationRevisionId"> <summary> The element of the Field FISHREVISIONID. The revision of the content object for which the annotation applies. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationContentObjectLogicalId"> <summary> The element of the Field FISHCONTENTOBJLOGICALID. The ContentObject LogicalId. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationContentObjectVersion"> <summary> The element of the Field FISHCONTENTOBJVERSION. The ContentObject version number. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationContentObjectLanguage"> <summary> The element of the Field FISHCONTENTOBJLANGUAGE. The ContentObject language. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationPublicationLogicalId"> <summary> The element of the Field FISHPUBLOGICALID. The publication LogicalId indicates the publication for which the annotation applies. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationPublicationVersion"> <summary> The element of the Field FISHPUBVERSION. The publication version number indicates the version of the publication for which the annotation applies. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationPublicationLanguage"> <summary> The element of the Field FISHPUBLANGUAGE. The publication language indicates the (working) language of the publication for which the annotation applies. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationType"> <summary> The element of the Field FISHANNOTATIONTYPE. The type of annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationText"> <summary> The element of the Field FISHANNOTATIONTEXT. The text of annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationStatus"> <summary> The element of the Field FISHANNOTATIONSTATUS. The status of annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationSelectedOriginalText"> <summary> The element of the Field FISHSELECTEDORIGINALTEXT. The original text on which the annotation was made. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationCategory"> <summary> The element of the Field FISHANNOTATIONCATEGORY. The category of annotation (e.g. Comment, Suggestion). </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationAddress"> <summary> The element of the Field FISHANNOTATIONADDRESS. The address of annotation. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationResolvedBy"> <summary> The element of the Field FISHANNOTRESOLVEDBY. The user which marked the annotation as resolved. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationResolvedOn"> <summary> The element of the Field FISHANNOTRESOLVEDON. The date when the annotation was marked as resolved. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.AnnotationSnapshotId"> <summary> The annotation last timestamp. The timestamp used on annotations to indicate when the annotation or one of the replies was last changed. </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.FieldElements.BackgroundTaskProgressId"> <summary> The ProgressId of the BackgroundTask. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshBackgroundTasks"> <summary> <para type="description">Container object to group multiple IshBackgroundTask entries holding BackgroundTask entries.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.IshBackgroundTasks._backgroundTasks"> <summary> List with the backgroundTasks </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshBackgroundTasks.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshBackgroundTasks"/> class. </summary> <param name="xmlIshBackgroundTasks">The xml containing the backgroundTasks.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshBackgroundTasks.#ctor(Trisoft.ISHRemote.Objects.Public.IshBackgroundTask[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshBackgroundTasks"/> class. </summary> <param name="ishBackgroundTasks">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask"/> array.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshBackgroundTasks.BackgroundTasks"> <summary> Gets the list with the current IshBackgroundTasks. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshBackgroundTasks.Ids"> <summary> Return all backgroundTask identifiers (field TASKID) present </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshBaselineItems"> <summary> <para type="description">Container object that groups multiple IshBaselineItem entries</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshBaselineItems.#ctor(System.String,System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshBaselineItems"/> class. </summary> <param name="baselineId">The identifier of the baseline</param> <param name="xmlIshBaselineItems">The xml containing the items.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshBaselineItems.#ctor(Trisoft.ISHRemote.Objects.Public.IshBaselineItem[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshBaselineItems"/> class. </summary> <param name="ishBaselineItems">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshBaselineItem"/> array.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshBaselineItems.Items"> <summary> Gets the current IshBaselineItems. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshBaseObject"> <summary> A generic base class for all ISH(Object) types holding IshFields. Mainly to make WrapAsPSObjectAndAddNoteProperties(...) implementation easier. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshBaseObject.IshFields"> <summary> Gets and sets the IshFields property. The IshFields property is a collection of <see cref="P:Trisoft.ISHRemote.Objects.IshBaseObject.IshFields"/>. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshEvents"> <summary> <para type="description">Container object to group multiple IshEvent entries holding EventMonitor entries.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.IshEvents._events"> <summary> List with the events </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshEvents.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshEvents"/> class. </summary> <param name="xmlIshEvents">The xml containing the events.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshEvents.#ctor(Trisoft.ISHRemote.Objects.Public.IshEvent[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshEvents"/> class. </summary> <param name="ishEvents">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshEvent"/> array.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshEvents.Events"> <summary> Gets the list with the current IshEvents. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshEvents.Ids"> <summary> Return all event identifiers (field EVENTID) present </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshFeatures"> <summary> <para type="description">Stores a collection of features called the context. All possible combinations will be used as input by ConditionFilter to make an @ishcondition true. For example combining BLUETOOTH=Y and GAMES=SNAKE</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.#ctor"> <summary> Creates an empty instance of the object. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.#ctor(Trisoft.ISHRemote.Objects.Public.IshFeature[])"> <summary> Creates an empty instance of the object. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.#ctor(System.Xml.XmlElement)"> <summary> Creates a new instance of the ishFeatures object. </summary> <param name="xmlFeatures">Xml element with the feature information.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshFeatures.Features"> <summary> Gets the current IshFeatures. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.Count"> <summary> Number of ishFeatures. </summary> <returns>Returns the number of ishFeatures.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.AddFeature(Trisoft.ISHRemote.Objects.Public.IshFeature)"> <summary> Add a ishFeature to the current list. </summary> <param name="ishFeature">IshFeature that needs to be added.</param> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFeatures"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.GetXml(System.Xml.XmlWriter@)"> <summary> Write the xml from the current list. </summary> <param name="xmlWriter">The <see cref="T:System.Xml.XmlWriter"/>.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFeatures.ToXml"> <summary> Get an xml string from the current list; </summary> <returns>A string with the xml.</returns> </member> <member name="T:Trisoft.ISHRemote.Objects.IshFields"> <summary> <para type="description">Container object to group multiple IshField entries, eaching holding one field metadata entry described by a name, optional level and value</para> <para type="description">Should not be used as cmdlet parameter, single IshField and IshField[] are more PowerShell friendly.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.#ctor"> <summary> Creates an empty instance of the ishfield object. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.#ctor(Trisoft.ISHRemote.Objects.Public.IshField[])"> <summary> Creates an instance based on the incoming IshField array or an empty instance. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.#ctor(System.Collections.Generic.List{Trisoft.ISHRemote.Objects.Public.IshField})"> <summary> Creates an instance based on the incoming IshField list or an empty instance. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.#ctor(System.Xml.XmlElement)"> <summary> Creates a new instance of the ishfield object. </summary> <param name="xmlIshFields">Xml element with the ishfield information.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.#ctor(System.Collections.Generic.ICollection{Trisoft.ISHRemote.OpenApiISH30.FieldValue},System.String)"> <summary> Creates a new instance based on the incoming OpenApi models. Any multi-value field are joined up by the separator (typically comma-space) </summary> <param name="oFieldValues">Incoming OpenApi Field Values</param> <param name="separator">Any multi-value field are joined up by the separator (typically comma-space), mostly coming from IshSession.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.Fields"> <summary> The current fields list. </summary> <returns>An array of <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.Count"> <summary> Number of fields. </summary> <returns>Returns the number of fields.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.ToRequestedFields"> <summary> Generates a new ishfields object where all fields only have requested field information (e.g. no Value, but ValueType if available) </summary> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.ToRequestedFields(Trisoft.ISHRemote.Objects.Enumerations.Level)"> <summary> Generates a new ishfields object where all fields only have requested field information (e.g. no Value, but ValueType if available) Remove all level entries that do not match the filter. </summary> <param name="filterFieldLevel">Level attribute that should be matched to be part of the result.</param> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.ToFilterFields"> <summary> Generates exact filters (using Equal operator) from the given fields </summary> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.AddField(Trisoft.ISHRemote.Objects.Public.IshField)"> <summary> Add a field to the current list. </summary> <param name="ishField">The field that needs to be added.</param> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.AddOrUpdateField(Trisoft.ISHRemote.Objects.Public.IshField,Trisoft.ISHRemote.Objects.Enumerations.ActionMode)"> <summary> Removes all previous fields and insert the given field </summary> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RemoveField(System.String,System.String,System.String)"> <summary> Remove a field from the current list. </summary> <param name="fieldName">The name of the field.</param> <param name="fieldLevel">The level of the field (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.Level"/>).</param> <param name="valueType">The type of the field (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.ValueType"/>).</param> <returns></returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RemoveField(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Remove a field from the current list. </summary> <param name="fieldName">The name of the field.</param> <param name="fieldLevel">The level of the field (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.Level"/>).</param> <param name="valueType">The type of the field (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.ValueType"/>).</param> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RemoveField(Trisoft.ISHRemote.Objects.Public.IshField)"> <summary> Remove a field from the current list. </summary> <param name="compareField">The <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/> that needs to be removed.</param> <returns>The current list of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.JoinFields(Trisoft.ISHRemote.Objects.IshFields,Trisoft.ISHRemote.Objects.Enumerations.ValueAction)"> <summary> Merge or Join the incoming ishfields (IshMetadataFields) on my own ishfields using the provided action </summary> <param name="ishFields">Fields to join with my own fields</param> <param name="valueAction">String action (overwrite/prepend/append) to use on matching fields</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.Retrieve(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level)"> <summary> Retrieves all occurances out of the list of IshFields </summary> <returns>An array of <see cref="T:Trisoft.ISHRemote.Objects.IshFields"/>.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RetrieveFirst(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Retrieves the first occurance out of the list of matching IshFields </summary> <returns>The first <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/> in the current list.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RetrieveFirst(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level)"> <summary> Retrieves the first occurance out of the list of matching IshFields; preferring Id over Element and then Value. So first Id '4484', if not present then Element 'VUSERADMIN', again if not present Value 'Admin'. </summary> <returns>The first <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/> in the current list.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.RetrieveFirst(System.String,System.String,System.String)"> <summary> Retrieves the first occurance out of the list of matching IshFields </summary> <returns>The first <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/> in the current list.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.Retrieve(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Retrieves a list of <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/> using a filter. </summary> <param name="fieldName">The field name.</param> <param name="fieldLevel">The field level <see cref="T:Trisoft.ISHRemote.Objects.Enumerations.Level"/>.</param> <param name="valueType">The value type <see cref="T:Trisoft.ISHRemote.Objects.Enumerations.ValueType"/>.</param> <returns>An array of <see cref="T:Trisoft.ISHRemote.Objects.Public.IshField"/>.</returns> <remarks></remarks> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.GetXml(System.Xml.XmlWriter@)"> <summary> Write the xml from the current list. </summary> <param name="xmlWriter">The <see cref="T:System.Xml.XmlWriter"/>.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.ToXml"> <summary> Get an xml string from the current list; </summary> <returns>A string with the xml.</returns> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFields.GetFieldValue(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Gets the value for a field. </summary> <param name="fieldName">The fieldname to get the value from.</param> <param name="fieldLevel">The fieldlevel (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.Level"/>).</param> <param name="valueType">The valuetype (<see cref="T:Trisoft.ISHRemote.Objects.Enumerations.ValueType"/>).</param> <returns></returns> </member> <member name="T:Trisoft.ISHRemote.Objects.IshFolders"> <summary> <para type="description">Container object to group multiple IshFolder objects</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFolders.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshFolders"/> class. </summary> <param name="xmlIshFolders">The xml containing the folders.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFolders.#ctor(System.String,System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshFolders"/> class. </summary> <param name="xmlIshFolders">The xml containing the folders.</param> <param name="nodePath">Path to the ishfolder node</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFolders.#ctor(Trisoft.ISHRemote.Objects.Public.IshFolder[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshFolders"/> class. </summary> <param name="ishFolders">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshFolder"/> array.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshFolders.#ctor(System.Collections.Generic.ICollection{Trisoft.ISHRemote.OpenApiISH30.Folder},System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshFolders"/> class. </summary> <param name="oFolders">OpenApi model</param> <param name="separator">Any multi-value field are joined up by the separator (typically comma-space), mostly coming from IshSession.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshFolders.Folders"> <summary> Gets the current IshFolders. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshFolders.FolderList"> <summary> Gets the current IshFolders as list </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshFolders.SortedFolders"> <summary> Gets the current IshFolders sorted by name </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshFolders.Ids"> <summary> Return all identifiers (ishfolderref) </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshLovValues"> <summary> <para type="description">Containter object grouping multiple IshLoveValue entries</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshLovValues.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshLovValues"/> class. </summary> <param name="xmlIshLovValues">The xml containing the LovValues.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshLovValues.#ctor(Trisoft.ISHRemote.Objects.Public.IshLovValue[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshLovValues"/> class. </summary> <param name="ishLovValues">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshLovValue"/> array.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshLovValues.TryGetIshLovValue(System.String,System.String,Trisoft.ISHRemote.Objects.Public.IshLovValue@)"> <summary> Returns the IshLovValue identified by LovId and LovValueId </summary> <param name="lovId">List of Value identifier like 'DRESOLUTION'</param> <param name="lovValueId">List of Value Value identifier, aka IshRef, like 'VRESHIGH'</param> <param name="ishLovValue">The complete initialized object including label and active flag</param> <returns></returns> </member> <member name="P:Trisoft.ISHRemote.Objects.IshLovValues.LovValues"> <summary> Gets the current IshLovValues. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshLovValues.ValueIds"> <summary> Return all LovValueId identifiers (ishref) </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshLovValues.Ids"> <summary> Return all Id identifiers (ishlovvalueref) </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshObjectFactory"> <summary> Factory to generate the most specific ISHType possible, so ISHDocumentObj over ISHObject, or ISHUser over ISHObject </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshObjectFactory.Get(Trisoft.ISHRemote.Objects.Enumerations.ISHType[],System.Xml.XmlElement)"> <summary> Simplest factory is to make the cmdlet in question (like Find-IshDocumentObj) mention which type its return. Typically in the cmdlet name. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshObjects"> <summary> <para type="description">Container object that groups multiple IshObject entries</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshObjects.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshObjects"/> class. </summary> <param name="xmlIshObjects">The xml containing the objects.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshObjects.#ctor(Trisoft.ISHRemote.Objects.Enumerations.ISHType[],System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshObjects"/> class over the IshObjectFactory </summary> <param name="ishType">The object type to create, derived from IshObject.</param> <param name="xmlIshObjects">The xml containing the objects.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshObjects.#ctor(Trisoft.ISHRemote.Objects.Public.IshObject[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshObjects"/> class. </summary> <param name="ishObjects">An <see cref="T:Trisoft.ISHRemote.Objects.Public.IshObject"/> array.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshObjects.Objects"> <summary> Gets the current IshObjects. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshObjects.Ids"> <summary> Return all logical/element identifiers (ishref) present </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshObjects.ObjectList"> <summary> Gets the current IshObjects as list </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshSearchResults"> <summary> <para type="description">Container object to group multiple SEQUENCED/ordered IshObject search result entries.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.IshSearchResults._searchResults"> <summary> List with the events </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshSearchResults.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.IshSearchResults"/> class. </summary> <param name="xmlIshSearchResults">The xml containing the search results.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.IshSearchResults.LngRefs"> <summary> Return all language card ids (ishlngrefs) of the search result in search order (by ishsequence) </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshSettingsExtensionConfig"> <summary> <para type="description">Stores the essence of IMetadataBinding configuration to merge into IshTypeFieldSetup</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshSettingsExtensionConfig.MergeIntoIshTypeFieldSetup(Trisoft.ISHRemote.Interfaces.ILogger,Trisoft.ISHRemote.Objects.IshTypeFieldSetup,System.String)"> <summary> For every metadata-bounded field, update the IshTypeFieldDefinition Terrible loop-code but only runs for 13.0.0 up to 14.0.4. Did not want to adapt future-proof IshTypeFieldSetup. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.IshTypeFieldSetup"> <summary> <para type="description">Provides functionality on IshTypeFieldDefinitions</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.IshTypeFieldSetup._ishTypeFieldDefinitions"> <summary> Lookup dictionary based on field identifier (like ISHType, Level, Name concatenation) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.IshTypeFieldSetup._strictMetadataPreference"> <summary> Client side filtering of nonexisting or unallowed metadata can be done silently, with warning or not at all. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.String,Trisoft.ISHRemote.Objects.Public.IshVersion)"> <summary> Creates a management object to work with the ISHType and FieldDefinitions. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.Collections.Generic.List{Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition})"> <summary> Returns a management object with sorting on the field definition key for comparison and nicer rendering </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.StrictMetadataPreference"> <summary> Client side filtering of nonexisting or unallowed metadata can be done silently, with warning or not at all. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.RemoveDuplicateFields(Trisoft.ISHRemote.Objects.IshFields)"> <summary> Remove IshField entries that by preferring ishvaluetype id over element over value </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.AddDescriptiveFields(System.Collections.Generic.IEnumerable{Trisoft.ISHRemote.Objects.Enumerations.ISHType},Trisoft.ISHRemote.Objects.IshFields)"> <summary> Reverse lookup for all fields that are marked descriptive for the incoming ishTypes; then add them to ishFields. Descriptive fields are fields who are database-object-wise consired primary key, so to uniquely identify an object. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.AddBasicFields(System.Collections.Generic.IEnumerable{Trisoft.ISHRemote.Objects.Enumerations.ISHType},Trisoft.ISHRemote.Objects.IshFields)"> <summary> Reverse lookup for all fields that are marked basic for the incoming ishTypes; then add them to ishFields. Basic fields are fields who offer user-friendly business logic. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.AddAllFields(System.Collections.Generic.IEnumerable{Trisoft.ISHRemote.Objects.Enumerations.ISHType},Trisoft.ISHRemote.Objects.IshFields)"> <summary> Reverse lookup for all fields that are marked basic for the incoming ishTypes; then add them to ishFields. All fields of the specified object ISHType, so all descriptive, basic, system fields. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.GetDataType(Trisoft.ISHRemote.Objects.Enumerations.ISHType,Trisoft.ISHRemote.Objects.Public.IshField)"> <summary> Returns the DataType of the specified field linked to the mentioned card type </summary> <param name="ishType">The card type</param> <param name="ishField">Field object indicating level and name</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.ToIshRequestedMetadataFields(Trisoft.ISHRemote.Objects.Enumerations.RequestedMetadataGroup,Trisoft.ISHRemote.Objects.Enumerations.ISHType[],Trisoft.ISHRemote.Objects.IshFields,Trisoft.ISHRemote.Objects.Enumerations.ActionMode)"> <summary> Requested metadata fields will be duplicated and enriched to cater our Public Objects initilization. The minimal fields (IsDescriptive) will be added to allow initialization of the various IshObject types for all ValueTypes. Unallowed fields for read operations (IshFieldDefinition.AllowOnRead) will be stripped with a Debug log message. </summary> <remarks>Logs debug entry for unknown combinations of ishTypes and ishField (name, level) entries - will not throw.</remarks> <param name="requestedMetadataGroup">Initialize return field set given the default/initial requested metadata, this way interactive mode becomes a lot less chatty</param> <param name="ishTypes">Given ISHTypes (like ISHMasterDoc, ISHLibrary, ISHConfiguration,...) to verify/alter the IshFields for</param> <param name="ishFields">Incoming IshFields entries will be transformed to matching and allowed IshRequestedMetadataField entries</param> <param name="actionMode">RequestedMetadataFields only has value for read operations like Read, Find, Search,...</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.ToIshMetadataFields(Trisoft.ISHRemote.Objects.Enumerations.ISHType[],Trisoft.ISHRemote.Objects.IshFields,Trisoft.ISHRemote.Objects.Enumerations.ActionMode)"> <summary> Metadata write operations will be duplicated and cleared client side. Unallowed fields for write operations (IshFieldDefinition.AllowOnCreate/AllowOnUpdate) will be stripped with a Debug log message. </summary> <remarks>Logs debug entry for unknown combinations of ishTypes, ishField (name, level), mandatory, multi-value,... entries - will not throw.</remarks> <param name="ishTypes">Given ISHTypes (like ISHMasterDoc, ISHLibrary, ISHConfiguration,...) to verify/alter the IshFields for</param> <param name="ishFields">Incoming IshFields entries will be transformed to matching and allowed IshMetadataField entries</param> <param name="actionMode">MetadataFields only has value for write operations like Create, Update,...</param> </member> <member name="M:Trisoft.ISHRemote.Objects.IshTypeFieldSetup.ToIshRequiredCurrentMetadataFields(Trisoft.ISHRemote.Objects.Enumerations.ISHType[],Trisoft.ISHRemote.Objects.IshFields,Trisoft.ISHRemote.Objects.Enumerations.ActionMode)"> <summary> Correctly named overload of ToIshMetadataFields(...). Allows tuning in the future. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshAnnotation"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshAnnotation.ObjectRef"> <summary> Returns the card_id for the Annotation </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshAnnotation.ReplyRef"> <summary> Returns the card_id for the Annotation reply </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshApplicationSetting"> <summary> <para type="description">Holds a single result of the GetTimeZone call containing network timestamps</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshApplicationSettings"> <summary> <para type="description">Container holding multiple results of GetTimeZone calls containing network timestamps allowing basic network statistics verification and calculation</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask"> <summary> <para type="description">The IshBackgroundTask is one entry on the BackgroundTask history are, also holding task top-level information.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.#ctor(System.Xml.XmlElement)"> <summary> IshBackgroundTask creation through an ishbackgroundTask xml element. Incoming is: <ishbackgroundtask ishtaskref="169075" ishhistoryref="122259"> </summary> <param name="xmlIshBackgroundTask">One ishbackgroundTask xml.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.IshRef"> <summary> Gets the IshRef property, better known as the backgroundTask id of the object. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.IshField"> <summary> Get a pipeline friendly base/specialized IshField objects as array </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.IshFields"> <summary> Gets and sets the IshFields property. The IshFields property is a collection of <see cref="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.IshFields"/>. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.TaskRef"> <summary> Returns the task id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBackgroundTask.HistoryRef"> <summary> Returns the history id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshBaseline"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBaseline.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshBaselineItem"> <summary> <para type="description">Generic pipeline object for the API holding various references</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshBaselineItem.#ctor(System.String,System.String,System.String)"> <summary> IshBaselineItem using explicit parameters </summary> <remarks>Source is set to Manual and the dates are automatically filled by the server-side business code</remarks> <param name="baselineId">The identifier of the baseline ishobject</param> <param name="logicalId">The logical identifier of the content object</param> <param name="version">The version of the content object</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshBaselineItem.#ctor(System.String,System.Xml.XmlElement)"> <summary> IshBaselineItem creation through an object xml element. Incoming is: <object ref="GUID.007DFDAD.CEFD.40F3.A75E.2C081228DC89" versionnumber="2" author="Admin" source="save:LatestAvailable" created="10/12/2008 15:05:09" modified="10/12/2008 15:05:09"/> </summary> <param name="baselineId">The identifier of the baseline ishobject</param> <param name="xmlIshBaselineItem">One object xml.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBaselineItem.CreatedOnAsSortableDateTime"> <summary> Property overload for *.format.ps1xml usage to allow sorting </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshBaselineItem.ModifiedOnAsSortableDateTime"> <summary> Property overload for *.format.ps1xml usage to allow sorting </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshData"> <summary> <para type="description">Object holding the file/blob information with Electronic Document Type (EDT) information like file extension</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshData.#ctor(System.String,System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.Public.IshData"/> class. </summary> <param name="edt">The EDT.</param> <param name="filePath">The location of the file.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshData.#ctor(System.String,System.Byte[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.Public.IshData"/> class. </summary> <param name="edt">The EDT.</param> <param name="fileContent">Byte array with the file content.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshData.#ctor(System.String,System.String,System.Byte[])"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.Public.IshData"/> class. </summary> <param name="edt">The EDT.</param> <param name="fileExtension">File extension</param> <param name="fileContent">Byte array with the file content.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshData.#ctor(System.Xml.XmlElement)"> <summary> Initializing by something that looks like <ishdata edt="EDTXML"><![CDATA[PFhNTEZJTEU+UHJvamVjdE1hbmFnZW1lbnQ/PC9YTUxGSUxFPg0K]]></ishdata> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshData.Edt"> <summary> Gets the EDT. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshData.FileExtension"> <summary> Gets the fileextension. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshData.ByteArray"> <summary> Gets the blob. </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshData.Size"> <summary> Gets the blob size. </summary> <returns>The number of bytes.</returns> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshDataObject"> <summary> <para type="description">Groups all file functionality required by Trisoft like edt, attributes, file size, mime type, Save, ToByteArray, init by ishdataobject xml element,...</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshDataObject.#ctor(System.Xml.XmlElement)"> <summary> Initializing by something that looks like <![CDATA[ <?xml version="1.0" encoding="utf-16"?> <ishdataobjects> <ishdataobject ishlngref="1826972" ishdataref="1826973" ed="GUID-7EE439B0-EE28-463A-A409-7AB83DE2E92D" edt="EDTCHM" size="35802" mimetype="application/mshelp" fileextension="chm" /> </ishdataobjects> ]]> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.Edt"> <summary> Gets the EDT. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.Ed"> <summary> Gets the identifier of the EDT. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.IshDataRef"> <summary> Gets the data reference id. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.Size"> <summary> Gets the size of the file (bytes). </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.MimeType"> <summary> Gets the mimetype of the file. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.FileExtension"> <summary> Gets the extension of the file. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDataObject.ObjectRef"> <summary> Stores the variations of ishlngref, ... </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshDocumentObj"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDocumentObj.ObjectRef"> <summary> Returns the logical card_id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDocumentObj.VersionRef"> <summary> Returns the version card_id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshDocumentObj.LngRef"> <summary> Returns the language card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshEDT"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEDT.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshEvent"> <summary> <para type="description">The IshEvent is one entry on the EventMonitor detail are, also holding progress top-level information.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshEvent.#ctor(System.Xml.XmlElement)"> <summary> IshEvent creation through an ishevent xml element. Incoming is: <ishevent ishprogressref="807"/> or <ishevent ishprogressref="807" ishdetailref="16317"/> </summary> <param name="xmlIshEvent">One ishevent xml.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.IshRef"> <summary> Gets the IshRef property, better known as the event id of the object. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.EventId"> <summary> Gets the EventId property </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.EventType"> <summary> Gets the type of the event </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.IshField"> <summary> Get a pipeline friendly base/specialized IshField objects as array </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.IshFields"> <summary> Gets and sets the IshFields property. The IshFields property is a collection of <see cref="P:Trisoft.ISHRemote.Objects.Public.IshEvent.IshFields"/>. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.IshEventData"> <summary> Gets and sets the IshEventData property. The IshData property is used to contain the blob (<see cref="T:Trisoft.ISHRemote.Objects.Public.IshData"/>). </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.ProgressRef"> <summary> Returns the progress id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEvent.DetailRef"> <summary> Returns the detail id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshEventData"> <summary> <para type="description">The IshEventData object is used to hold Event binary information.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshEventData.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.Public.IshEventData"/> class. </summary> <param name="content">The content for the event data</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshEventData.#ctor(System.Xml.XmlElement)"> <summary> Initializing by something that looks like <ishdata size="70500"><![CDATA[RQB4AGkAdABDAG8AZABlADoAIAAtADIAMAAwADAAMwANAAoATQBpAGMAcgBvAHMAbwBmAHQAIAAoAFIAKQAgAF ... ]]></ishdata> for IshEvent </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEventData.Size"> <summary> Gets the Size. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshEventData.ByteArray"> <summary> Gets the blob. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshFeature"> <summary> <para type="description">Stores a single feature part of the context that will be used as input by ConditionFilter to make an @ishcondition true. For example BLUETOOTH=Y</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFeature.Name"> <summary> Gets name of the feature </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFeature.Value"> <summary> Gets value of the feature </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshFeature.GetXml(System.Xml.XmlWriter@)"> <summary> Gets xml for the feature object </summary> <param name="xmlWriter"></param> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshField"> <summary> <para type="description">Holds one field metadata entry described by a name, optional level and value</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshField.ToRequestedMetadataField"> <summary> Generates a new ishfield object where the field only has requested field information (e.g. no Value, but ValueType if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshField.ToMetadataFilterField"> <summary> Generates a new ishfield object where the field becomes a filter field (e.g. with Value, ValueType, operator if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshField.ToMetadataField"> <summary> Generates a new ishfield object where the field becomes a metadata field (e.g. with Value, ValueType) </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshFolder"> <summary> <para type="description">Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshFolder.#ctor(System.Int64,Trisoft.ISHRemote.Objects.Enumerations.IshFolderType,Trisoft.ISHRemote.Objects.IshFields)"> <summary> IshFolder creation through explicitly listing all fields. </summary> <param name="ishFolderRef">Folder reference in the InfoShare</param> <param name="ishFolderType">Folder type</param> <param name="ishFields">????</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshFolder.#ctor(System.Xml.XmlElement)"> <summary> IshFolder creation through an ishfolder xml element. </summary> <param name="xmlIshFolder">One ishfolder xml.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshFolder.#ctor(Trisoft.ISHRemote.OpenApiISH30.Folder,System.String)"> <summary> Creates a new instance of the <see cref="T:Trisoft.ISHRemote.Objects.Public.IshFolder"/> class. </summary> <param name="oFolder">OpenApi model</param> <param name="separator">Any multi-value field are joined up by the separator (typically comma-space), mostly coming from IshSession.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshType"> <summary> Gets the IshType property. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshFolderRef"> <summary> Gets ishfolderref property of the folder </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshFolderType"> <summary> Gets ishfoldertype property of the folder </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshField"> <summary> Get a pipeline friendly base/specialized IshField objects as array </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshFields"> <summary> Gets and sets the IshFields property. The IshFields property is a collection of <see cref="P:Trisoft.ISHRemote.Objects.Public.IshFolder.IshFields"/>. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshLovValue"> <summary> <para type="description">Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshLovValue.#ctor(System.String,System.Xml.XmlElement)"> <summary> IshLovValue creation through an ishlovvalue xml element. </summary> <param name="lovId">Id of a list of values e.g. DERESOLUTION</param> <param name="xmlIshLovValue">One ishlovvalue xml.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshLovValue.LovId"> <summary> Gets the Id of a list of values e.g. DRESOLUTION </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshLovValue.IshLovValueRef"> <summary> Gets ishlovvalueref property of the LovValue </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshLovValue.IshRef"> <summary> Gets ishRef property of the LovValue </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshLovValue.Label"> <summary> Gets label field of the LovValue </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshLovValue.Description"> <summary> Gets description field of the LovValue </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshMetadataField"> <summary> <para type="description">Stores field name and level information via IshField. Adds a value type and value to allow set and get</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.#ctor(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,System.String)"> <summary> Constructs a Set IshField </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.#ctor(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType,System.String)"> <summary> Constructs a Get/Requested IshField </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.#ctor(Trisoft.ISHRemote.Objects.Public.IshMetadataField)"> <summary> Copy constructor </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.#ctor(System.Xml.XmlElement)"> <summary> Constructs a Value Field with whatever information available </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.ToRequestedMetadataField"> <summary> Generates a new ishfield object where the field only has requested field information (e.g. no Value, but ValueType if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.ToMetadataFilterField"> <summary> Generates a new ishfield object where the field becomes a filter field (e.g. with Value, ValueType, operator if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.ToMetadataField"> <summary> Generates a new ishfield object where the field becomes a metadata field (e.g. with Value, ValueType) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.GetXml(System.Xml.XmlWriter@)"> <summary> Convert the IshField object to xml. </summary> <param name="xmlWriter">The <see cref="T:System.Xml.XmlWriter"/>.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataField.ToString"> <summary> Debugging implementation </summary> <returns>string</returns> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField"> <summary> <para type="description">Stores field name and level information via IshField. Adds a comparison/filter operator and value to allow filtering</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.#ctor(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.FilterOperator,System.String,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Constructs a Set IshField </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.#ctor(Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField)"> <summary> Copy constructor </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.ToRequestedMetadataField"> <summary> Generates a new ishfield object where the field only has requested field information (e.g. no Value, but ValueType if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.ToMetadataFilterField"> <summary> Generates a new ishfield object where the field becomes a filter field (e.g. with Value, ValueType, operator if available) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.ToMetadataField"> <summary> Generates a new ishfield object where the field becomes a metadata field (e.g. with Value, ValueType) </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshMetadataFilterField.ToString"> <summary> Debugging implementation </summary> <returns>string</returns> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshObject"> <summary> <para type="description">Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshObject.#ctor(Trisoft.ISHRemote.Objects.Enumerations.ISHType,System.String,Trisoft.ISHRemote.Objects.IshFields)"> <summary> IshObject creation through an IshField can (I think?!!) be done if you explicitly list all fields. </summary> <remarks>IshObject is typically only returned from the repository through an xml container.</remarks> <param name="ishType">Type indication, like ISHOutputFormat, ISHLibrary,...</param> <param name="ishRef">An element name, not that for some types this will be overwritten with a generated one</param> <param name="ishFields">The functions down the line will extract the required ishfields for real object creation.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshObject.#ctor(System.Xml.XmlElement)"> <summary> IshObject creation through an ishobject xml element. Incoming is: <ishobject ishref="D1E1030" ishtype="ISHModule" ishlogicalref="26288" ishversionref="26291" ishlngref="39490" /> </summary> <param name="xmlIshObject">One ishobject xml.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshRef"> <summary> Gets the IshRef property, better known as the logical id of the object. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshType"> <summary> Gets the IshType property. Possible values are all card types (ISHUserGroup, ISHEDT, ISHOutputFormat...) </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshField"> <summary> Get a pipeline friendly base/specialized IshField objects as array </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshFields"> <summary> Gets and sets the IshFields property. The IshFields property is a collection of <see cref="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshFields"/>. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshData"> <summary> Gets and sets the IshData property. The IshData property is used to contain the blob (<see cref="P:Trisoft.ISHRemote.Objects.Public.IshObject.IshData"/>). </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshObject.ObjectRef"> <summary> Stores the variations of ishlogicalref, ishuserref, ishoutputformatref,... If there are more references, like log/ver/Lng then they are available in the dictionary. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshOutputFormat"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshOutputFormat.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshPublicationOutput"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshPublicationOutput.ObjectRef"> <summary> Returns the logical card_id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshPublicationOutput.VersionRef"> <summary> Returns the version card_id </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshPublicationOutput.LngRef"> <summary> Returns the language card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshRequestedMetadataField"> <summary> <para type="description">Stores field name and level information via IshField.</para> </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshRequestedMetadataField.#ctor(System.String,Trisoft.ISHRemote.Objects.Enumerations.Level,Trisoft.ISHRemote.Objects.Enumerations.ValueType)"> <summary> Constructs a Set IshField </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshRequestedMetadataField.#ctor(Trisoft.ISHRemote.Objects.Public.IshRequestedMetadataField)"> <summary> Copy constructor </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshRequestedMetadataField.ToString"> <summary> Debugging implementation </summary> <returns>string</returns> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshSession"> <summary> <para type="description">Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</para> <para type="description">Furthermore it tracks your security token, provides direct client access to the web services API.</para> <para type="description">Gives access to contract parameters like separators, date formats, batch and chunk sizes.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshSession._chunkSize"> <summary> Used by the SOAP API that retrieves files/blobs in multiple chunk, this parameter is the chunksize (10485760 bytes is 10Mb) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshSession._metadataBatchSize"> <summary> Used to divide bigger data set retrievals in multiple API calls, 999 is the best optimization server-side (Oracle IN-clause only allows 999 values, so 1000 would mean 2x queries server-side) </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshSession._clientAppId"> <summary> OpenIdConnect Client Application Id that is typically configured in Access Management (ISHID) to allow a local redirect (http://127.0.0.1:SomePort/) This option is not typically used but allows validating other applications like Tridion_Docs_Content_Importer </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshSession.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,System.String,System.String,System.Security.SecureString,System.String,System.Security.SecureString,System.TimeSpan,System.Boolean,Trisoft.ISHRemote.Objects.Enumerations.Protocol)"> <summary> Creates a session object holding contracts and proxies to the web services API. Takes care of username/password and 'Active Directory' authentication (NetworkCredential) to the Secure Token Service. </summary> <param name="logger">Instance of the ILogger interface to allow some logging although Write-* is not very thread-friendly.</param> <param name="webServicesBaseUrl">The url to the web service API. For example 'https://example.com/ISHWS/'</param> <param name="ishUserName">InfoShare user name. For example 'Admin'</param> <param name="ishSecurePassword">Matching password as SecureString of the incoming user name. When null is provided, a NetworkCredential() is created instead.</param> <param name="clientId">Access Management (ISHAM) Client Identifier of a Service Account. For example 'c826e7e1-c35c-43fe-9756-e1b61f44bb40'</param> <param name="clientSecureSecret">Access Management (ISHAM) Client Secret is the matching password as SecureString of the clientId.For example 'ziKiGbx6N0G3m69/vWMZUTs2paVO1Mzqt6Y6TX7mnpPJyFVODsAAAA=='.</param> <param name="timeout">Timeout to control Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml</param> <param name="ignoreSslPolicyErrors">IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</param> <param name="protocol">Protocol indicates the preferred communication/authentication route.</param> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.IshUserName"> <summary> The user name used to authenticate to the service, is initialized to Environment.UserName in case of Windows Authentication through NetworkCredential() </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.ClientId"> <summary> The Client ID of the client/secret combination you passed for Credential Flow authentication (most likely over Access Management (ISHAM)). </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.UserName"> <summary> The user name as available on the InfoShare User Profile in the CMS under field 'USERNAME' </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.UserLanguage"> <summary> The user language as available on the InfoShare User Profile in the CMS under field 'FISHUSERLANGUAGE' </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.ClientIshVersion"> <summary> Retrieving assembly file version, actually can take up to 500 ms to get this initialized, so moved code to JIT property </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.AccessToken"> <summary> Access Token is also known as Bearer Token </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.ClientAppId"> <summary> OpenIdConnect Client Application Id that is typically configured in Access Management (ISHID) to allow a local redirect (http://127.0.0.1:SomePort/) This option is not typically used but allows validating other applications like Tridion_Docs_Content_Importer </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.Timeout"> <summary> Timeout to control Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.MetadataBatchSize"> <summary> Web Service Retrieve batch size, if implemented, expressed in number of Ids/Objects for usage in metadata calls </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.StrictMetadataPreference"> <summary> Client side filtering of nonexisting or unallowed metadata can be done silently, with warning or not at all. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.PipelineObjectPreference"> <summary> Allows tuning client-side object enrichment like no wrapping (off) or PSObject-with-PSNoteProperty wrapping. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.DefaultRequestedMetadata"> <summary> Any RequestedMetadata will be preloaded with the Descriptive/Basic/All metadata fields known for the ISHType[] in use by the cmdlet A potential override/append by the specified -RequestedMetadata is possible. </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.BlobBatchSize"> <summary> Web Service Retrieve batch size, if implemented, expressed in number of Ids/Objects for usage in blob/ishdata calls </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshSession.ChunkSize"> <summary> Web Service Retrieve chunk size, if implemented, expressed in bytes </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition"> <summary> <para type="description">Object holding the denormalized ISHType (like ISHMasterDoc, ISHEvent,...) with field information (like FTITLE, PROGRESS,..).</para> </summary> <example> <ishtypedefinition name="ISHUser"> <ishfielddefinition level="none" name="FUSERGROUP" type="ishreference" ismandatory="false" ismultivalue="true" allowonread="true" allowoncreate="true" allowonupdate="true" allowonsearch="true" issystem="true" isbasic="true" isdescriptive="false"> <label>Usergroup</label> <description>Used on all card types.On the USER card type the field indicates that the user has write/modify access to documents of this usergroup.On all other objects the field contains the usergroup that owns the object and can modify the object.</description> <ishreference> <ishtype ishref = "ISHUserGroup" /> </ishreference> </ishfielddefinition> <ishfielddefinition name="FTESTCONTINENTS" level="logical" type="ishmetadatabinding" ismandatory="false" ismultivalue="true" allowonread="true" allowoncreate="true" allowonupdate="true" allowonsearch="true" allowonsmarttagging="false" issystem="false" isbasic="true" isdescriptive="false"> <label>Continents Test Field</label> <description>Used to test a string field with metadata binding configured.</description> <ishmetadatabinding sourceref = "CitiesConnector" /> </ishfielddefinition> ... </ishtypedefinition> </example> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.DataSource"> <summary> PS1XML Shorthand notation of DataType-(ReferenceMetadataBinding/ReferenceLov/ReferenceType) properties </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.MM"> <summary> PS1XML Shorthand notation of Mandatory-MultiValue properties </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.CRUST"> <summary> PS1XML Shorthand notation of Create-Read-Update-Search-AllowOnSmartTagging properties </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.SDB"> <summary> PS1XML Shorthand notation of System-Descriptive-Basic </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.Key"> <summary> Unique descriptive identifier of an IshTypeFieldDefinition concatenating type, level (respecting log/version/lng), and field name </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,Trisoft.ISHRemote.Objects.Enumerations.ISHType,System.Xml.XmlElement)"> <summary> IshTypeFieldDefinition creation through an xml element. See Settings25.RetrieveFieldSetupByIshType </summary> <param name="logger">Instance of the ILogger interface to allow some logging although Write-* is not very thread-friendly.</param> <param name="ishType">Card type identifier</param> <param name="xmlDef">One IshTypeFieldDefinition xml.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,Trisoft.ISHRemote.Objects.Enumerations.ISHType,Trisoft.ISHRemote.Objects.Enumerations.Level,System.String,Trisoft.ISHRemote.Objects.Enumerations.DataType)"> <summary> IshTypeFieldDefinition creation with the bare descriptive identifiers, defaulting values to AllowOnRead only </summary> <param name="logger">Instance of the ILogger interface to allow some logging although Write-* is not very thread-friendly.</param> <param name="ishType">Card type identifier</param> <param name="level">The level of the field on this ISHType (card type)</param> <param name="name">The name of the field</param> <param name="dataType">The field data type, indicating reference field or simple type</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.#ctor(Trisoft.ISHRemote.Interfaces.ILogger,Trisoft.ISHRemote.Objects.Enumerations.ISHType,Trisoft.ISHRemote.Objects.Enumerations.Level,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,Trisoft.ISHRemote.Objects.Enumerations.DataType,System.String,System.String,System.String,System.Collections.Generic.List{Trisoft.ISHRemote.Objects.Enumerations.ISHType})"> <summary> IshTypeFieldDefinition creation with the full descriptive identifiers </summary> <param name="logger">Instance of the ILogger interface to allow some logging although Write-* is not very thread-friendly.</param> <param name="ishType">Card type identifier</param> <param name="level">The level of the field on this ISHType (card type)</param> <param name="isMandatory">Boolean attribute indicating whether the field is mandatory or not. </param> <param name="isMultiValue">Boolean attribute indicating whether the field can contain multiple values or not. </param> <param name="allowOnRead">Boolean attribute indicating whether the field can be passed as filter or passed as requested metadata to an API READ method (e.g. GetMetadata, RetrieveMetadata, Find,...). </param> <param name="allowOnCreate">Boolean attribute indicating whether the field can be set via metadata by an API CREATE method. Note: Some fields(e.g.USERNAME) must be passed as a parameter to the CREATE method.So, although these fields are mandatory, they will have allowoncreate false! </param> <param name="allowOnUpdate">Boolean attribute indicating whether the field can be set via metadata by an API UPDATE method (e.g. SetMetadata, Update,...). </param> <param name="allowOnSearch">Boolean attribute indicating whether the field is part of the full text index and can be used as part of the search query. </param> <param name="allowOnSmartTagging">Boolean attribute indicating whether the field supports Smart Tagging. </param> <param name="isSystem">Boolean attribute indicating whether this field is part of the internal Content Manager business logic. </param> <param name="isBasic">Boolean attribute indicating whether this field is a basic field (e.g. FSTATUS) or a more advanced field (e.g. FISHSTATUSTYPE). </param> <param name="isDescriptive">Boolean attribute indicating whether this field is one of the fields that define an object. Note: These fields are also used by the internal Content Manager business code, therefore they don't require an extra call to the database when requested. </param> <param name="name">Name of the card field or the table column.</param> <param name="dataType">The field data type, indicating reference field or simple type</param> <param name="referenceLov">Lists the referenced list of values name (e.g. USERNAME or DBACKGROUNDTASKSTATUS)</param> <param name="referenceMetadataBinding">Lists the sourceref for the MetadataBinding (e.g. CitiesConnector)</param> <param name="description">Free text description, anything which can help an implementor</param> <param name="referenceType">A list of ISHType (e.g. ISHUser) to specify the type of object to which the field is referenced. Default value indicates an empty list of reference types which means no reference to an object.</param> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.#ctor(Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition)"> <summary> Copy constructor </summary> </member> <member name="M:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition.CompareTo(System.Object)"> <summary> The role of IComparable is to provide a method of comparing two objects of a particular type. This is necessary if you want to provide any ordering capability for your object. </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare"> <summary> <para type="description">Object holding the denormalized ISHType (like ISHMasterDoc, ISHEvent,...) with field information (like FTITLE, PROGRESS,..) including a compare result.</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare.Compare.Identical"> <summary> <para type="description">Compare result indicates the entry exists in both lists with the same descriptive properties</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare.Compare.LeftDifferent"> <summary> <para type="description">Compare result indicates the entry exists in both lists with differences on the descriptive properties, showing left entry</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare.Compare.RightDifferent"> <summary> <para type="description">Compare result indicates the entry exists in both lists with differences on the descriptive properties, showing right entry</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare.Compare.LeftOnly"> <summary> <para type="description">Compare result indicates the entry only exist in the left list</para> </summary> </member> <member name="F:Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare.Compare.RightOnly"> <summary> <para type="description">Compare result indicates the entry only exist in the right list</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshUser"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshUser.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshUserGroup"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshUserGroup.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshUserRole"> <summary> <para type="description">A container to allow *.Format.ps1xml do magic, in essence the same as the pipeline object IshObject</para> </summary> </member> <member name="P:Trisoft.ISHRemote.Objects.Public.IshUserRole.ObjectRef"> <summary> Returns the card_id </summary> </member> <member name="T:Trisoft.ISHRemote.Objects.Public.IshVersion"> <summary> <para type="description">Stores a version number. It knows how to parse InfoShare version numbers regarding compatibility and build information</para> </summary> </member> <member name="T:Trisoft.ISHRemote.Properties.Resouces.ISHTypeFieldSetup"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Trisoft.ISHRemote.Properties.Resouces.ISHTypeFieldSetup.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Trisoft.ISHRemote.Properties.Resouces.ISHTypeFieldSetup.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Trisoft.ISHRemote.Properties.Resouces.ISHTypeFieldSetup.TriDKXmlSetupFullExport_12_00_01"> <summary> Looks up a localized string similar to &lt;?xml version="1.0"?&gt; &lt;?xml-stylesheet href="full.export.xsl" type="text/xsl"?&gt; &lt;!-- InfoShare Author 3.5.0 --&gt; &lt;tridk:setup xml:lang="EN" xmlns:tridk="urn:trisoft.be:Tridk:Setup:1.0" tridk:version="120.11.0.3215"&gt; &lt;tridk:cardtypes&gt; &lt;!-- General cardtypes --&gt; &lt;tridk:cardtype tridk:exportmode="cascade" tridk:element="USER" tridk:metatype="usercard"&gt; &lt;tridk:displaydefinition&gt; &lt;tridk:label&gt;User&lt;/tridk:label&gt; &lt;tridk:descript [rest of string was truncated]";. </summary> </member> </members> </doc> |