API Reference
Class
FileWorkspaceBrowseResult
Result returned by workspace browse operations.
Inheritance
- Object
- FileWorkspaceBrowseResult
Constructors
public FileWorkspaceBrowseResult(Boolean IsAvailable, String CurrentPath, String ParentPath, IReadOnlyList<FileWorkspaceEntry> Entries, Int32 TotalEntryCount, String Summary) #Result returned by workspace browse operations.
Parameters
- IsAvailable System.Boolean
- True when the browse request succeeded.
- CurrentPath System.String
- Current browsed path when applicable.
- ParentPath System.String
- Parent path when applicable and allowed.
- Entries System.Collections.Generic.IReadOnlyList{ComputerX.FileSystem.FileWorkspaceEntry}
- Entries returned for the current browse scope.
- TotalEntryCount System.Int32
- Number of entries returned.
- Summary System.String
- Human-readable operation summary.
Methods
public FileWorkspaceBrowseResult <Clone>$() #Returns:
FileWorkspaceBrowseResultpublic Void Deconstruct(out Boolean IsAvailable, out String CurrentPath, out String ParentPath, out IReadOnlyList<FileWorkspaceEntry> Entries, out Int32 TotalEntryCount, out String Summary) #Returns:
VoidParameters
- IsAvailable Boolean
- CurrentPath String
- ParentPath String
- Entries IReadOnlyList<FileWorkspaceEntry>
- TotalEntryCount Int32
- Summary String
public virtual Boolean Equals(FileWorkspaceBrowseResult other) #Returns:
BooleanParameters
- obj Object
public override Int32 GetHashCode() #Returns:
Int32public override String ToString() #Returns:
StringInherited Methods
Properties
public virtual Boolean IsAvailable { get; set; } #True when the browse request succeeded.
public String CurrentPath { get; set; } #Current browsed path when applicable.
public String ParentPath { get; set; } #Parent path when applicable and allowed.
public IReadOnlyList<FileWorkspaceEntry> Entries { get; set; } #Entries returned for the current browse scope.
public Int32 TotalEntryCount { get; set; } #Number of entries returned.
public String Summary { get; set; } #Human-readable operation summary.
public virtual String Message { get; } #Gets the human-readable operation summary using the shared status contract name.