Interface IProjectsGroupsApiExecutor

Namespace: Crowdin.Api.ProjectsGroups

Assembly: Crowdin.Api.dll

Syntax

[PublicAPI]
public interface IProjectsGroupsApiExecutor

Methods

| Edit this page View Source

AddGroup(AddGroupRequest)

Declaration

Task<Group> AddGroup(AddGroupRequest request)

Parameters

Type	Name	Description
AddGroupRequest	request

Returns

Type	Description
Task<Group>

| Edit this page View Source

AddProjectFileFormatSettings(long, AddProjectFileFormatSettingsRequest)

Declaration

Task<FileFormatSettingsResource> AddProjectFileFormatSettings(long projectId, AddProjectFileFormatSettingsRequest request)

Parameters

Type	Name	Description
long	projectId
AddProjectFileFormatSettingsRequest	request

Returns

Type	Description
Task<FileFormatSettingsResource>

| Edit this page View Source

AddProjectStringsExporterSettings(long, AddProjectStringsExporterSettingsRequest)

Declaration

Task<StringsExporterSettingsResource> AddProjectStringsExporterSettings(long projectId, AddProjectStringsExporterSettingsRequest request)

Parameters

Type	Name	Description
long	projectId
AddProjectStringsExporterSettingsRequest	request

Returns

Type	Description
Task<StringsExporterSettingsResource>

| Edit this page View Source

AddProject<T>(AddProjectRequest)

Declaration

Task<T> AddProject<T>(AddProjectRequest request) where T : ProjectBase

Parameters

Type	Name	Description
AddProjectRequest	request

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

DeleteGroup(long)

Declaration

Task DeleteGroup(long groupId)

Parameters

Type	Name	Description
long	groupId

Returns

Type	Description
Task

| Edit this page View Source

DeleteProject(long)

Declaration

Task DeleteProject(long projectId)

Parameters

Type	Name	Description
long	projectId

Returns

Type	Description
Task

| Edit this page View Source

DeleteProjectFileFormatSettings(long, long)

Declaration

Task DeleteProjectFileFormatSettings(long projectId, long fileFormatSettingsId)

Parameters

Type	Name	Description
long	projectId
long	fileFormatSettingsId

Returns

Type	Description
Task

| Edit this page View Source

DeleteProjectStringsExporterSettings(long, long)

Declaration

Task DeleteProjectStringsExporterSettings(long projectId, long stringsExporterSettingsId)

Parameters

Type	Name	Description
long	projectId
long	stringsExporterSettingsId

Returns

Type	Description
Task

| Edit this page View Source

DownloadProjectFileFormatSettingsCustomSegmentation(long, long)

Declaration

Task<DownloadLink> DownloadProjectFileFormatSettingsCustomSegmentation(long projectId, long fileFormatSettingsId)

Parameters

Type	Name	Description
long	projectId
long	fileFormatSettingsId

Returns

Type	Description
Task<DownloadLink>

| Edit this page View Source

EditGroup(long, IEnumerable<GroupPatch>)

Declaration

Task<Group> EditGroup(long groupId, IEnumerable<GroupPatch> patches)

Parameters

Type	Name	Description
long	groupId
IEnumerable<GroupPatch>	patches

Returns

Type	Description
Task<Group>

| Edit this page View Source

EditProjectFileFormatSettings(long, long, IEnumerable<ProjectFileFormatSettingsPatch>)

Declaration

Task<FileFormatSettingsResource> EditProjectFileFormatSettings(long projectId, long fileFormatSettingsId, IEnumerable<ProjectFileFormatSettingsPatch> patches)

Parameters

Type	Name	Description
long	projectId
long	fileFormatSettingsId
IEnumerable<ProjectFileFormatSettingsPatch>	patches

Returns

Type	Description
Task<FileFormatSettingsResource>

| Edit this page View Source

EditProjectStringsExporterSettings(long, long, IEnumerable<ProjectStringsExporterSettingsPatch>)

Declaration

Task<StringsExporterSettingsResource> EditProjectStringsExporterSettings(long projectId, long stringsExporterSettingsId, IEnumerable<ProjectStringsExporterSettingsPatch> patches)

Parameters

Type	Name	Description
long	projectId
long	stringsExporterSettingsId
IEnumerable<ProjectStringsExporterSettingsPatch>	patches

Returns

Type	Description
Task<StringsExporterSettingsResource>

| Edit this page View Source

EditProject<T>(long, IEnumerable<ProjectPatch>)

Declaration

Task<T> EditProject<T>(long projectId, IEnumerable<ProjectPatch> patches) where T : ProjectBase

Parameters

Type	Name	Description
long	projectId
IEnumerable<ProjectPatch>	patches

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

GetGroup(long)

Declaration

Task<Group> GetGroup(long groupId)

Parameters

Type	Name	Description
long	groupId

Returns

Type	Description
Task<Group>

| Edit this page View Source

GetProjectFileFormatSettings(long, long)

Declaration

Task<FileFormatSettingsResource> GetProjectFileFormatSettings(long projectId, long fileFormatSettingsId)

Parameters

Type	Name	Description
long	projectId
long	fileFormatSettingsId

Returns

Type	Description
Task<FileFormatSettingsResource>

| Edit this page View Source

GetProjectStringsExporterSettings(long, long)

Declaration

Task<StringsExporterSettingsResource> GetProjectStringsExporterSettings(long projectId, long stringsExporterSettingsId)

Parameters

Type	Name	Description
long	projectId
long	stringsExporterSettingsId

Returns

Type	Description
Task<StringsExporterSettingsResource>

| Edit this page View Source

GetProject<T>(long)

Declaration

Task<T> GetProject<T>(long projectId) where T : ProjectBase

Parameters

Type	Name	Description
long	projectId

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

ListGroups(long?, int, int, IEnumerable<SortingRule>?)

Declaration

Task<ResponseList<Group>> ListGroups(long? parentId, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long?	parentId
int	limit
int	offset
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<Group>>

| Edit this page View Source

ListProjectFileFormatSettings(long)

Declaration

Task<ResponseList<FileFormatSettingsResource>> ListProjectFileFormatSettings(long projectId)

Parameters

Type	Name	Description
long	projectId

Returns

Type	Description
Task<ResponseList<FileFormatSettingsResource>>

| Edit this page View Source

ListProjectStringsExporterSettings(long)

Declaration

Task<ResponseList<StringsExporterSettingsResource>> ListProjectStringsExporterSettings(long projectId)

Parameters

Type	Name	Description
long	projectId

Returns

Type	Description
Task<ResponseList<StringsExporterSettingsResource>>

| Edit this page View Source

ListProjects<TProject>(long?, long?, bool, ProjectType?, int, int, IEnumerable<SortingRule>?)

Declaration

Task<ResponseList<TProject>> ListProjects<TProject>(long? userId = null, long? groupId = null, bool hasManagerAccess = false, ProjectType? type = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null) where TProject : ProjectBase

Parameters

Type	Name	Description
long?	userId
long?	groupId
bool	hasManagerAccess
ProjectType?	type
int	limit
int	offset
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<TProject>>

Type Parameters

Name	Description
TProject

| Edit this page View Source

ResetProjectFileFormatSettingsCustomSegmentation(long, long)

Declaration

Task ResetProjectFileFormatSettingsCustomSegmentation(long projectId, long fileFormatSettingsId)

Parameters

Type	Name	Description
long	projectId
long	fileFormatSettingsId

Returns

Type	Description
Task