Class SourceFilesApiExecutor

Inheritance

System.Object

SourceFilesApiExecutor

Namespace: Crowdin.Api.SourceFiles

Assembly: Crowdin.Api.dll

Syntax

public class SourceFilesApiExecutor : object

Constructors

| Improve this Doc View Source

SourceFilesApiExecutor(ICrowdinApiClient)

Declaration

public SourceFilesApiExecutor(ICrowdinApiClient apiClient)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient

| Improve this Doc View Source

SourceFilesApiExecutor(ICrowdinApiClient, IJsonParser)

Declaration

public SourceFilesApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient
IJsonParser	jsonParser

Methods

| Improve this Doc View Source

AddBranch(Int32, AddBranchRequest)

Add branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Add directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Add file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Build reviewed source files. Documentation: Crowdin Enterprise API

Declaration

public async 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)

Check reviewed source files build status. Documentation: Crowdin Enterprise API

Declaration

public async 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)

Delete branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Delete directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Delete file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Download file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Download file preview. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Download reviewed source files. Documentation: Crowdin Enterprise API

Declaration

public async 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>)

Edit branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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>)

Edit directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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>)

Edit file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Get branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Get directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Get file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

Get file revision. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

List branches. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

List directories. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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>>)

List directories. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public 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)

List file revisions. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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)

List files. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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>>)

List files. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public 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)

List reviewed source files builds. Documentation: Crowdin Enterprise API

Declaration

public async 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)

Update or Restore file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

public async 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>>>