Interface IUsersApiExecutor

Namespace: Crowdin.Api.Users
Assembly: Crowdin.Api.dll
Syntax
public interface IUsersApiExecutor

Methods

| Improve this Doc View Source

AddProjectMember(Int32, AddProjectMemberRequest)

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

DeleteMemberFromProject(Int32, Int32)

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

DeleteUser(Int32)

Declaration
Task DeleteUser(int userId)
Parameters
Type Name Description
System.Int32 userId
Returns
Type Description
Task
| Improve this Doc View Source

EditUser(Int32, IEnumerable<EnterpriseUserPatch>)

Declaration
Task<UserEnterprise> EditUser(int userId, IEnumerable<EnterpriseUserPatch> patches)
Parameters
Type Name Description
System.Int32 userId
IEnumerable<EnterpriseUserPatch> patches
Returns
Type Description
Task<UserEnterprise>
| Improve this Doc View Source

GetAuthenticatedUser<T>()

Declaration
Task<T> GetAuthenticatedUser<T>()
    where T : UserBase
Returns
Type Description
Task<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

GetGroupManager(Int32, Int32)

Declaration
Task<GroupManager> GetGroupManager(int groupId, int userId)
Parameters
Type Name Description
System.Int32 groupId
System.Int32 userId
Returns
Type Description
Task<GroupManager>
| Improve this Doc View Source

GetMemberInfo(Int32, Int32)

Declaration
Task<TeamMember> GetMemberInfo(int projectId, int memberId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 memberId
Returns
Type Description
Task<TeamMember>
| Improve this Doc View Source

GetProjectMemberPermissions(Int32, Int32)

Declaration
Task<ProjectMember> GetProjectMemberPermissions(int projectId, int memberId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 memberId
Returns
Type Description
Task<ProjectMember>
| Improve this Doc View Source

GetUser(Int32)

Declaration
Task<UserEnterprise> GetUser(int userId)
Parameters
Type Name Description
System.Int32 userId
Returns
Type Description
Task<UserEnterprise>
| Improve this Doc View Source

InviteUser(EnterpriseInviteUserRequest)

Declaration
Task<UserEnterprise> InviteUser(EnterpriseInviteUserRequest request)
Parameters
Type Name Description
EnterpriseInviteUserRequest request
Returns
Type Description
Task<UserEnterprise>
| Improve this Doc View Source

ListGroupManagers(Int32, Nullable<IEnumerable<Int32>>, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<GroupManager>> ListGroupManagers(int groupId, IEnumerable<int>? teamIds = null, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 groupId
System.Nullable<IEnumerable<System.Int32>> teamIds
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<GroupManager>>
| Improve this Doc View Source

ListProjectMembers(Int32, ProjectMembersListParams)

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

ListProjectMembers(Int32, Nullable<String>, Nullable<UserRole>, Nullable<String>, Int32, Int32, Nullable<IEnumerable<SortingRule>>)

Declaration
Task<ResponseList<TeamMember>> ListProjectMembers(int projectId, string? search = null, UserRole? role = null, string? languageId = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)
Parameters
Type Name Description
System.Int32 projectId
System.Nullable<System.String> search
System.Nullable<UserRole> role
System.Nullable<System.String> languageId
System.Int32 limit
System.Int32 offset
System.Nullable<IEnumerable<SortingRule>> orderBy
Returns
Type Description
Task<ResponseList<TeamMember>>
| Improve this Doc View Source

ListProjectMembersEnterprise(Int32, EnterpriseProjectMembersListParams)

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

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

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

ListUsers(EnterpriseUsersListParams)

Declaration
Task<ResponseList<UserEnterprise>> ListUsers(EnterpriseUsersListParams params)
Parameters
Type Name Description
EnterpriseUsersListParams params
Returns
Type Description
Task<ResponseList<UserEnterprise>>
| Improve this Doc View Source

ListUsers(Nullable<UserStatus>, Nullable<String>, Nullable<UserTwoFactorStatus>, Int32, Int32, Nullable<IEnumerable<SortingRule>>, Nullable<IEnumerable<OrganizationRole>>, Nullable<Int32>, Nullable<IEnumerable<Int32>>, Nullable<IEnumerable<ProjectRole>>, Nullable<IEnumerable<String>>, Nullable<IEnumerable<Int32>>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Declaration
Task<ResponseList<UserEnterprise>> ListUsers(UserStatus? status = null, string? search = null, UserTwoFactorStatus? twoFactor = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null, IEnumerable<OrganizationRole>? organizationRoles = null, int? teamId = null, IEnumerable<int>? projectIds = null, IEnumerable<ProjectRole>? projectRoles = null, IEnumerable<string>? languageIds = null, IEnumerable<int>? groupIds = null, DateTimeOffset? lastSeenFrom = null, DateTimeOffset? lastSeenTo = null)
Parameters
Type Name Description
System.Nullable<UserStatus> status
System.Nullable<System.String> search
System.Nullable<UserTwoFactorStatus> twoFactor
System.Int32 limit
System.Int32 offset
System.Nullable<IEnumerable<SortingRule>> orderBy
System.Nullable<IEnumerable<OrganizationRole>> organizationRoles
System.Nullable<System.Int32> teamId
System.Nullable<IEnumerable<System.Int32>> projectIds
System.Nullable<IEnumerable<ProjectRole>> projectRoles
System.Nullable<IEnumerable<System.String>> languageIds
System.Nullable<IEnumerable<System.Int32>> groupIds
System.Nullable<DateTimeOffset> lastSeenFrom
System.Nullable<DateTimeOffset> lastSeenTo
Returns
Type Description
Task<ResponseList<UserEnterprise>>
| Improve this Doc View Source

ReplaceProjectMemberPermissions(Int32, Int32, ReplaceProjectMemberPermissionsRequest)

Declaration
Task<ProjectMember> ReplaceProjectMemberPermissions(int projectId, int memberId, ReplaceProjectMemberPermissionsRequest request)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 memberId
ReplaceProjectMemberPermissionsRequest request
Returns
Type Description
Task<ProjectMember>
| Improve this Doc View Source

UpdateGroupManagers(Int32, IEnumerable<GroupManagerPatch>)

Declaration
Task<ResponseList<GroupManager>> UpdateGroupManagers(int groupId, IEnumerable<GroupManagerPatch> patches)
Parameters
Type Name Description
System.Int32 groupId
IEnumerable<GroupManagerPatch> patches
Returns
Type Description
Task<ResponseList<GroupManager>>