Get-RDMEntryAttachment

    2024-11-18

    Get-RDMEntryAttachment

    SYNOPSIS

    Get attachments of an entry

    SYNTAX

    Name

    Get-RDMEntryAttachment [-InputObject] <PSConnection> [-Filename <string[]>] [-Title <string[]>]
 [-CaseSensitive] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get attachments of an entry. They can filtered by their filename and title. Only advanced data sources support attachments

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment

    Get all the attachments of the entry EntryA

    EXAMPLE 2

    PS C:> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Title 'UniqueTitle' | Update-RDMEntryCommand -Filename 'revisedFile.txt' -Refresh

    Update the document of the attachment 'UniqueTitle' with the file 'revisedFile.txt' in the current session directory.

    EXAMPLE 3

    PS C:> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment -Filename 'UniqueTitle' -CaseSensitive | Update-RDMEntryCommand -Filename 'revisedFile.txt' -Refresh

    Update the document of the attachment 'UniqueTitle' with the file 'revisedFile.txt' in the current session directory.

    EXAMPLE 4

    PS C:> Get-RDMEntry -Name EntryA | Get-RDMEntryAttachment | Set-RDMEntryAttachment -AllowExport $false

    Prevent the export of all EntryA's attachments.

    PARAMETERS

    -CaseSensitive

    Filtering by the title and the filename will be case sensitive.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Filename

    Filter the attachments based on their filename.

    Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ForcePromptAnswer

    Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

    • Yes: Accept the prompt. Cover the OK and Automatic value.
    • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -InputObject

    Specifies the connection to get the attachments from.

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Title

    Filter the attachments based on their title.

    Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

    PSConnection object of the entry where the attachments will be. Can be obtained from Get-RDMEntry.

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnectionAttachment

    NOTES

    For more information, type "Get-Help Get-RDMEntryAttachment -detailed". For technical information, type "Get-Help Get-RDMEntryAttachment -full".