Class RemoteWorkFile
Contains information about a remote work file.
Inheritance
RemoteWorkFile
Assembly: PrizmDocServerSDK.dll
Syntax
public class RemoteWorkFile : IEquatable<RemoteWorkFile>
Properties
AffinityToken
Gets affinity token of the remote work file, identifying the remote server the file is stored on.
Declaration
public string AffinityToken { get; }
Property Value
FileExtension
Gets file extension for the remote work file, indicating the file type.
Declaration
public string FileExtension { get; }
Property Value
FileId
Gets unique id of the remote work file.
Declaration
public string FileId { get; }
Property Value
Methods
CopyToAsync(Stream)
Downloads the remote work file and copies it to a local stream.
Declaration
public Task CopyToAsync(Stream stream)
Parameters
| Type |
Name |
Description |
| Stream |
stream |
Stream where the file should be copied to.
|
Returns
| Type |
Description |
| Task |
A Task representing the result of the asynchronous operation.
|
Equals(RemoteWorkFile)
Declaration
public bool Equals(RemoteWorkFile other)
Parameters
Returns
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| Object |
obj |
|
Returns
Overrides
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
SaveAsync(String)
Downloads the remote work file and saves it to a local file path.
Declaration
public Task SaveAsync(string localFilePath)
Parameters
| Type |
Name |
Description |
| String |
localFilePath |
Path where the file should be written to.
|
Returns
| Type |
Description |
| Task |
A Task representing the result of the asynchronous operation.
|
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements