Interface ISourceFilesApiExecutor

Namespace: Crowdin.Api.SourceFiles
Assembly: Crowdin.Api.dll
Syntax
public interface ISourceFilesApiExecutor

Methods

| Improve this Doc View Source

AddBranch(Int32, AddBranchRequest)

Declaration
Task<Branch> AddBranch(int projectId, AddBranchRequest request)
Parameters
Type Name Description
System.Int32 projectId
AddBranchRequest request
Returns
Type Description
Task<Branch>
| Improve this Doc View Source

AddDirectory(Int32, AddDirectoryRequest)

Declaration
Task<Directory> AddDirectory(int projectId, AddDirectoryRequest request)
Parameters
Type Name Description
System.Int32 projectId
AddDirectoryRequest request
Returns
Type Description
Task<Directory>
| Improve this Doc View Source

AddFile(Int32, AddFileRequest)

Declaration
Task<File> AddFile(int projectId, AddFileRequest request)
Parameters
Type Name Description
System.Int32 projectId
AddFileRequest request
Returns
Type Description
Task<File>
| Improve this Doc View Source

BuildReviewedSourceFiles(Int32, BuildReviewedSourceFilesRequest)

Declaration
Task<ReviewedStringBuild> BuildReviewedSourceFiles(int projectId, BuildReviewedSourceFilesRequest request)
Parameters
Type Name Description
System.Int32 projectId
BuildReviewedSourceFilesRequest request
Returns
Type Description
Task<ReviewedStringBuild>
| Improve this Doc View Source

CheckReviewedSourceFilesBuildStatus(Int32, Int32)

Declaration
Task<ReviewedStringBuild> CheckReviewedSourceFilesBuildStatus(int projectId, int buildId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 buildId
Returns
Type Description
Task<ReviewedStringBuild>
| Improve this Doc View Source

DeleteBranch(Int32, Int32)

Declaration
Task DeleteBranch(int projectId, int branchId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 branchId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteDirectory(Int32, Int32)

Declaration
Task DeleteDirectory(int projectId, int directoryId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 directoryId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteFile(Int32, Int32)

Declaration
Task DeleteFile(int projectId, int fileId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
Returns
Type Description
Task
| Improve this Doc View Source

DownloadFile(Int32, Int32)

Declaration
Task<DownloadLink> DownloadFile(int projectId, int fileId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

DownloadFilePreview(Int32, Int32)

Declaration
Task<DownloadLink> DownloadFilePreview(int projectId, int fileId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

DownloadReviewedSourceFiles(Int32, Int32)

Declaration
Task<DownloadLink> DownloadReviewedSourceFiles(int projectId, int buildId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 buildId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

EditBranch(Int32, Int32, IEnumerable<BranchPatch>)

Declaration
Task<Branch> EditBranch(int projectId, int branchId, IEnumerable<BranchPatch> patches)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 branchId
IEnumerable<BranchPatch> patches
Returns
Type Description
Task<Branch>
| Improve this Doc View Source

EditDirectory(Int32, Int32, IEnumerable<DirectoryPatch>)

Declaration
Task<Directory> EditDirectory(int projectId, int directoryId, IEnumerable<DirectoryPatch> patches)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 directoryId
IEnumerable<DirectoryPatch> patches
Returns
Type Description
Task<Directory>
| Improve this Doc View Source

EditFile(Int32, Int32, IEnumerable<FilePatch>)

Declaration
Task<File> EditFile(int projectId, int fileId, IEnumerable<FilePatch> patches)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
IEnumerable<FilePatch> patches
Returns
Type Description
Task<File>
| Improve this Doc View Source

GetBranch(Int32, Int32)

Declaration
Task<Branch> GetBranch(int projectId, int branchId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 branchId
Returns
Type Description
Task<Branch>
| Improve this Doc View Source

GetDirectory(Int32, Int32)

Declaration
Task<Directory> GetDirectory(int projectId, int directoryId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 directoryId
Returns
Type Description
Task<Directory>
| Improve this Doc View Source

GetFile<TResponse>(Int32, Int32)

Declaration
Task<TResponse> GetFile<TResponse>(int projectId, int fileId)
    where TResponse : FileInfoResource
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Improve this Doc View Source

GetFileRevision(Int32, Int32, Int32)

Declaration
Task<RevisionResource> GetFileRevision(int projectId, int fileId, int revisionId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
System.Int32 revisionId
Returns
Type Description
Task<RevisionResource>
| Improve this Doc View Source

ListBranches(Int32, Nullable<String>, Int32, Int32)

Declaration
Task<ResponseList<Branch>> ListBranches(int projectId, string? name = null, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Int32 projectId
System.Nullable<System.String> name
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<Branch>>
| Improve this Doc View Source

ListDirectories(Int32, DirectoriesListParams)

Declaration
Task<ResponseList<Directory>> ListDirectories(int projectId, DirectoriesListParams params)
Parameters
Type Name Description
System.Int32 projectId
DirectoriesListParams params
Returns
Type Description
Task<ResponseList<Directory>>
| Improve this Doc View Source

ListDirectories(Int32, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<String>, Nullable<Object>, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<Directory>> ListDirectories(int projectId, int limit = 25, int offset = 0, int? branchId = null, int? directoryId = null, string? filter = null, object? recursion = null, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 limit
System.Int32 offset
System.Nullable<System.Int32> branchId
System.Nullable<System.Int32> directoryId
System.Nullable<System.String> filter
System.Nullable<System.Object> recursion
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<Directory>>
| Improve this Doc View Source

ListFileRevisions(Int32, Int32, Int32, Int32)

Declaration
Task<ResponseList<RevisionResource>> ListFileRevisions(int projectId, int fileId, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<RevisionResource>>
| Improve this Doc View Source

ListFiles<T>(Int32, FilesListParams)

Declaration
Task<ResponseList<T>> ListFiles<T>(int projectId, FilesListParams params)
    where T : FileResourceBase
Parameters
Type Name Description
System.Int32 projectId
FilesListParams params
Returns
Type Description
Task<ResponseList<T>>
Type Parameters
Name Description
T
| Improve this Doc View Source

ListFiles<T>(Int32, Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<String>, Nullable<Object>, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<T>> ListFiles<T>(int projectId, int limit = 25, int offset = 0, int? branchId = null, int? directoryId = null, string? filter = null, object? recursion = null, IEnumerable<SortingRule>? orderBy = null)
    where T : FileResourceBase
Parameters
Type Name Description
System.Int32 projectId
System.Int32 limit
System.Int32 offset
System.Nullable<System.Int32> branchId
System.Nullable<System.Int32> directoryId
System.Nullable<System.String> filter
System.Nullable<System.Object> recursion
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<T>>
Type Parameters
Name Description
T
| Improve this Doc View Source

ListReviewedSourceFilesBuilds(Int32, Nullable<Int32>, Int32, Int32)

Declaration
Task<ResponseList<ReviewedStringBuild>> ListReviewedSourceFilesBuilds(int projectId, int? branchId, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Int32 projectId
System.Nullable<System.Int32> branchId
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<ReviewedStringBuild>>
| Improve this Doc View Source

UpdateOrRestoreFile(Int32, Int32, UpdateOrRestoreFileRequest)

Declaration
Task<(File File, bool? IsModified)> UpdateOrRestoreFile(int projectId, int fileId, UpdateOrRestoreFileRequest request)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 fileId
UpdateOrRestoreFileRequest request
Returns
Type Description
Task<System.ValueTuple<File, System.Nullable<System.Boolean>>>