Search Results for

    Show / Hide Table of Contents

    Class ProjectsGroupsApiExecutor

    Inheritance
    object
    ProjectsGroupsApiExecutor
    Implements
    IProjectsGroupsApiExecutor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Crowdin.Api.ProjectsGroups
    Assembly: Crowdin.Api.dll
    Syntax
    public class ProjectsGroupsApiExecutor : IProjectsGroupsApiExecutor

    Constructors

    | Edit this page View Source

    ProjectsGroupsApiExecutor(ICrowdinApiClient)

    Declaration
    public ProjectsGroupsApiExecutor(ICrowdinApiClient apiClient)
    Parameters
    Type Name Description
    ICrowdinApiClient apiClient
    | Edit this page View Source

    ProjectsGroupsApiExecutor(ICrowdinApiClient, IJsonParser)

    Declaration
    public ProjectsGroupsApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)
    Parameters
    Type Name Description
    ICrowdinApiClient apiClient
    IJsonParser jsonParser

    Methods

    | Edit this page View Source

    AddGroup(AddGroupRequest)

    Add group. Documentation: Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public Task<Group> AddGroup(AddGroupRequest request)
    Parameters
    Type Name Description
    AddGroupRequest request
    Returns
    Type Description
    Task<Group>
    | Edit this page View Source

    AddProjectFileFormatSettings(long, AddProjectFileFormatSettingsRequest)

    Add Project File Format Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Add Project Strings Exporter Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Add project. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Delete group. Documentation: Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public Task DeleteGroup(long groupId)
    Parameters
    Type Name Description
    long groupId
    Returns
    Type Description
    Task
    | Edit this page View Source

    DeleteProject(long)

    Delete project. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public Task DeleteProject(long projectId)
    Parameters
    Type Name Description
    long projectId
    Returns
    Type Description
    Task
    | Edit this page View Source

    DeleteProjectFileFormatSettings(long, long)

    Delete Project File Format Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Delete Project Strings Exporter Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Download Project File Format Settings Custom Segmentation. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>)

    Edit group. Documentation: Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>)

    Edit Project File Format Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>)

    Edit Project Strings Exporter Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>)

    Edit project. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Get group. Documentation: Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public Task<Group> GetGroup(long groupId)
    Parameters
    Type Name Description
    long groupId
    Returns
    Type Description
    Task<Group>
    | Edit this page View Source

    GetProjectFileFormatSettings(long, long)

    Get Project File Format Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Get Project Strings Exporter Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Get project. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>?)

    List groups. Documentation: Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    List Project File Format Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    List Project Strings Exporter Settings. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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>?)

    List projects. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public 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)

    Reset Project File Format Settings Custom Segmentation. Documentation: Crowdin API Crowdin Enterprise API

    Declaration
    [PublicAPI]
    public Task ResetProjectFileFormatSettingsCustomSegmentation(long projectId, long fileFormatSettingsId)
    Parameters
    Type Name Description
    long projectId
    long fileFormatSettingsId
    Returns
    Type Description
    Task

    Implements

    IProjectsGroupsApiExecutor
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX