FileShare¶
File-share channel option payload for Document API distribution.
Compilation status: This type is defined in
Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionMethod.cs, which is present in this library's source directory but is not listed in the<Compile>item group ofSAIF.BOF.Business.Policy.Audit.ApiCalls.csproj. It is a source-included artifact and is not part of the compiledSAIF.Business.Policy.Audit.ApiCallsassembly's public surface.
Purpose¶
- Describe where the generated document should be named and dropped when a file-share route is used.
Context¶
- Namespace:
SAIF.Business.Policy.Audit.ApiCalls - Assembly/package:
SAIF.Business.Policy.Audit.ApiCalls
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| DistributionMethodType | public string DistributionMethodType { get; } |
Exposes FileShare as the discriminator for this delivery-channel payload. |
| FilePrefix | public string FilePrefix { get; set; } |
Prefix applied to the file name when the document is written to the file share. |
| FolderName | public string FolderName { get; set; } |
Target folder the document is dropped into on the file share. |
Behavioral notes¶
- The class inherits
DistributionMethodTypefromDistributionMethod<FileShare>.
Constraints and usage notes¶
- Folder-path semantics are defined by the downstream service, not by this library.
Sources¶
Business\SAIF.Business.Policy.Audit.ApiCalls\DistributionMethod.cs