FulcrumFS FulcrumFS
FulcrumFS FulcrumFS
DocFX + Singulink = ♥

Search Results for

    Method IFileRepo.GetVariantAsync

    IFileRepo.GetVariantAsync(FileId, string)

    Gets an existing variant of a file.

    Declaration
    ValueTask<IRepoFile> IFileRepo.GetVariantAsync(FileId fileId, string variantId)
    Parameters
    Type Name Description
    FileId fileId

    The ID of the main file.

    string variantId

    The ID of the variant. Variant IDs consist of ASCII letters, digits, hyphens and underscores and are case-insensitive.

    Returns
    Type Description
    ValueTask<IRepoFile>
    Implements
    IFileRepo.GetVariantAsync(FileId, string)
    Remarks

    A variant stored as an alias resolves to the content of its source. A retired variant is not found, even while its content has not been physically removed yet.

    Exceptions
    Type Condition
    RepoFileNotFoundException

    The file or the variant does not exist.

    DanglingAliasException

    The variant is an alias whose source data file is missing (a subtype of RepoFileNotFoundException).

    ArgumentException

    variantId is empty or contains characters that are not allowed.

    © Singulink. All rights reserved.