Class SourceFilesApiExecutor

Inheritance

object

SourceFilesApiExecutor

Implements

ISourceFilesApiExecutor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Crowdin.Api.SourceFiles

Assembly: Crowdin.Api.dll

Syntax

public class SourceFilesApiExecutor : ISourceFilesApiExecutor

Constructors

| Edit this page View Source

SourceFilesApiExecutor(ICrowdinApiClient)

Declaration

public SourceFilesApiExecutor(ICrowdinApiClient apiClient)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient

| Edit this page View Source

SourceFilesApiExecutor(ICrowdinApiClient, IJsonParser)

Declaration

public SourceFilesApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient
IJsonParser	jsonParser

Methods

| Edit this page View Source

AddBranch(long, AddBranchRequest)

Add branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
[Obsolete("This API is deprecated, see Crowdin.Api.Branches namespace")]
public Task<Branch> AddBranch(long projectId, AddBranchRequest request)

Parameters

Type	Name	Description
long	projectId
AddBranchRequest	request

Returns

Type	Description
Task<Branch>

| Edit this page View Source

AddDirectory(long, AddDirectoryRequest)

Add directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Directory> AddDirectory(long projectId, AddDirectoryRequest request)

Parameters

Type	Name	Description
long	projectId
AddDirectoryRequest	request

Returns

Type	Description
Task<Directory>

| Edit this page View Source

AddFile(long, AddFileRequest)

Add file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<File> AddFile(long projectId, AddFileRequest request)

Parameters

Type	Name	Description
long	projectId
AddFileRequest	request

Returns

Type	Description
Task<File>

| Edit this page View Source

BuildReviewedSourceFiles(long, BuildReviewedSourceFilesRequest)

Build reviewed source files. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ReviewedStringBuild> BuildReviewedSourceFiles(long projectId, BuildReviewedSourceFilesRequest request)

Parameters

Type	Name	Description
long	projectId
BuildReviewedSourceFilesRequest	request

Returns

Type	Description
Task<ReviewedStringBuild>

| Edit this page View Source

CheckReviewedSourceFilesBuildStatus(long, long)

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

Declaration

[PublicAPI]
public Task<ReviewedStringBuild> CheckReviewedSourceFilesBuildStatus(long projectId, long buildId)

Parameters

Type	Name	Description
long	projectId
long	buildId

Returns

Type	Description
Task<ReviewedStringBuild>

| Edit this page View Source

DeleteBranch(long, long)

Delete branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
[Obsolete("This API is deprecated, see Crowdin.Api.Branches namespace")]
public Task DeleteBranch(long projectId, long branchId)

Parameters

Type	Name	Description
long	projectId
long	branchId

Returns

Type	Description
Task

| Edit this page View Source

DeleteDirectory(long, long)

Delete directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteDirectory(long projectId, long directoryId)

Parameters

Type	Name	Description
long	projectId
long	directoryId

Returns

Type	Description
Task

| Edit this page View Source

DeleteFile(long, long)

Delete file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteFile(long projectId, long fileId)

Parameters

Type	Name	Description
long	projectId
long	fileId

Returns

Type	Description
Task

| Edit this page View Source

DownloadFile(long, long)

Download file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<DownloadLink> DownloadFile(long projectId, long fileId)

Parameters

Type	Name	Description
long	projectId
long	fileId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadFilePreview(long, long)

Download file preview. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<DownloadLink> DownloadFilePreview(long projectId, long fileId)

Parameters

Type	Name	Description
long	projectId
long	fileId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

DownloadReviewedSourceFiles(long, long)

Download reviewed source files. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<DownloadLink> DownloadReviewedSourceFiles(long projectId, long buildId)

Parameters

Type	Name	Description
long	projectId
long	buildId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

EditBranch(long, long, IEnumerable<BranchPatch>)

Edit branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
[Obsolete("This API is deprecated, see Crowdin.Api.Branches namespace")]
public Task<Branch> EditBranch(long projectId, long branchId, IEnumerable<BranchPatch> patches)

Parameters

Type	Name	Description
long	projectId
long	branchId
IEnumerable<BranchPatch>	patches

Returns

Type	Description
Task<Branch>

| Edit this page View Source

EditDirectory(long, long, IEnumerable<DirectoryPatch>)

Edit directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Directory> EditDirectory(long projectId, long directoryId, IEnumerable<DirectoryPatch> patches)

Parameters

Type	Name	Description
long	projectId
long	directoryId
IEnumerable<DirectoryPatch>	patches

Returns

Type	Description
Task<Directory>

| Edit this page View Source

EditFile(long, long, IEnumerable<FilePatch>)

Edit file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<File> EditFile(long projectId, long fileId, IEnumerable<FilePatch> patches)

Parameters

Type	Name	Description
long	projectId
long	fileId
IEnumerable<FilePatch>	patches

Returns

Type	Description
Task<File>

| Edit this page View Source

GetBranch(long, long)

Get branch. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
[Obsolete("This API is deprecated, see Crowdin.Api.Branches namespace")]
public Task<Branch> GetBranch(long projectId, long branchId)

Parameters

Type	Name	Description
long	projectId
long	branchId

Returns

Type	Description
Task<Branch>

| Edit this page View Source

GetDirectory(long, long)

Get directory. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<Directory> GetDirectory(long projectId, long directoryId)

Parameters

Type	Name	Description
long	projectId
long	directoryId

Returns

Type	Description
Task<Directory>

| Edit this page View Source

GetFileRevision(long, long, long)

Get file revision. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<RevisionResource> GetFileRevision(long projectId, long fileId, long revisionId)

Parameters

Type	Name	Description
long	projectId
long	fileId
long	revisionId

Returns

Type	Description
Task<RevisionResource>

| Edit this page View Source

GetFile<TResponse>(long, long)

Get file. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<TResponse> GetFile<TResponse>(long projectId, long fileId) where TResponse : FileInfoResource

Parameters

Type	Name	Description
long	projectId
long	fileId

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ListBranches(long, string?, int, int)

List branches. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
[Obsolete("This API is deprecated, see Crowdin.Api.Branches namespace")]
public Task<ResponseList<Branch>> ListBranches(long projectId, string? name = null, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long	projectId
string	name
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<Branch>>

| Edit this page View Source

ListDirectories(long, DirectoriesListParams)

List directories. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Directory>> ListDirectories(long projectId, DirectoriesListParams @params)

Parameters

Type	Name	Description
long	projectId
DirectoriesListParams	params

Returns

Type	Description
Task<ResponseList<Directory>>

| Edit this page View Source

ListDirectories(long, int, int, long?, long?, string?, object?, IEnumerable<SortingRule>?)

List directories. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<Directory>> ListDirectories(long projectId, int limit = 25, int offset = 0, long? branchId = null, long? directoryId = null, string? filter = null, object? recursion = null, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long	projectId
int	limit
int	offset
long?	branchId
long?	directoryId
string	filter
object	recursion
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<Directory>>

| Edit this page View Source

ListFileRevisions(long, long, int, int)

List file revisions. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<RevisionResource>> ListFileRevisions(long projectId, long fileId, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long	projectId
long	fileId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<RevisionResource>>

| Edit this page View Source

ListFiles<T>(long, FilesListParams)

List files. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<T>> ListFiles<T>(long projectId, FilesListParams @params) where T : FileResourceBase

Parameters

Type	Name	Description
long	projectId
FilesListParams	params

Returns

Type	Description
Task<ResponseList<T>>

Type Parameters

Name	Description
T

| Edit this page View Source

ListFiles<T>(long, int, int, long?, long?, string?, object?, IEnumerable<SortingRule>?)

List files. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<T>> ListFiles<T>(long projectId, int limit = 25, int offset = 0, long? branchId = null, long? directoryId = null, string? filter = null, object? recursion = null, IEnumerable<SortingRule>? orderBy = null) where T : FileResourceBase

Parameters

Type	Name	Description
long	projectId
int	limit
int	offset
long?	branchId
long?	directoryId
string	filter
object	recursion
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<T>>

Type Parameters

Name	Description
T

| Edit this page View Source

ListReviewedSourceFilesBuilds(long, long?, int, int)

List reviewed source files builds. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<ReviewedStringBuild>> ListReviewedSourceFilesBuilds(long projectId, long? branchId, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long	projectId
long?	branchId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<ReviewedStringBuild>>

| Edit this page View Source

UpdateOrRestoreFile(long, long, UpdateOrRestoreFileRequest)

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

Declaration

[PublicAPI]
public Task<(File File, bool? IsModified)> UpdateOrRestoreFile(long projectId, long fileId, UpdateOrRestoreFileRequest request)

Parameters

Type	Name	Description
long	projectId
long	fileId
UpdateOrRestoreFileRequest	request

Returns

Type	Description
Task<(File File, bool? IsModified)>

Implements

ISourceFilesApiExecutor