Class UsersApiExecutor

Inheritance

object

UsersApiExecutor

Implements

IUsersApiExecutor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Crowdin.Api.Users

Assembly: Crowdin.Api.dll

Syntax

public class UsersApiExecutor : IUsersApiExecutor

Constructors

| Edit this page View Source

UsersApiExecutor(ICrowdinApiClient)

Declaration

public UsersApiExecutor(ICrowdinApiClient apiClient)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient

| Edit this page View Source

UsersApiExecutor(ICrowdinApiClient, IJsonParser)

Declaration

public UsersApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)

Parameters

Type	Name	Description
ICrowdinApiClient	apiClient
IJsonParser	jsonParser

Methods

| Edit this page View Source

AddProjectMember(long, AddProjectMemberRequest)

Add project member. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ProjectMembersResponse> AddProjectMember(long projectId, AddProjectMemberRequest request)

Parameters

Type	Name	Description
long	projectId
AddProjectMemberRequest	request

Returns

Type	Description
Task<ProjectMembersResponse>

| Edit this page View Source

DeleteMemberFromProject(long, long)

Delete member from project. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteMemberFromProject(long projectId, long memberId)

Parameters

Type	Name	Description
long	projectId
long	memberId

Returns

Type	Description
Task

| Edit this page View Source

DeleteUser(long)

Delete user. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task DeleteUser(long userId)

Parameters

Type	Name	Description
long	userId

Returns

Type	Description
Task

| Edit this page View Source

EditUser(long, IEnumerable<EnterpriseUserPatch>)

Edit user. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<UserEnterprise> EditUser(long userId, IEnumerable<EnterpriseUserPatch> patches)

Parameters

Type	Name	Description
long	userId
IEnumerable<EnterpriseUserPatch>	patches

Returns

Type	Description
Task<UserEnterprise>

| Edit this page View Source

GetAuthenticatedUser<T>()

Get authenticated user. Documentation: Crowdin API Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<T> GetAuthenticatedUser<T>() where T : UserBase

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

GetGroupManager(long, long)

Get Group Manager. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<GroupManager> GetGroupManager(long groupId, long userId)

Parameters

Type	Name	Description
long	groupId
long	userId

Returns

Type	Description
Task<GroupManager>

| Edit this page View Source

GetMemberInfo(long, long)

Get member info. Documentation: Crowdin API

Declaration

[PublicAPI]
public Task<TeamMember> GetMemberInfo(long projectId, long memberId)

Parameters

Type	Name	Description
long	projectId
long	memberId

Returns

Type	Description
Task<TeamMember>

| Edit this page View Source

GetProjectMemberPermissions(long, long)

Get project member permissions. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ProjectMember> GetProjectMemberPermissions(long projectId, long memberId)

Parameters

Type	Name	Description
long	projectId
long	memberId

Returns

Type	Description
Task<ProjectMember>

| Edit this page View Source

GetUser(long)

Get user. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<UserEnterprise> GetUser(long userId)

Parameters

Type	Name	Description
long	userId

Returns

Type	Description
Task<UserEnterprise>

| Edit this page View Source

InviteUser(EnterpriseInviteUserRequest)

Invite user. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<UserEnterprise> InviteUser(EnterpriseInviteUserRequest request)

Parameters

Type	Name	Description
EnterpriseInviteUserRequest	request

Returns

Type	Description
Task<UserEnterprise>

| Edit this page View Source

ListGroupManagers(long, IEnumerable<long>?, IEnumerable<SortingRule>?)

List Group Managers. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<GroupManager>> ListGroupManagers(long groupId, IEnumerable<long>? teamIds = null, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long	groupId
IEnumerable<long>	teamIds
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<GroupManager>>

| Edit this page View Source

ListProjectMembers(long, ProjectMembersListParams)

List project members. Documentation: Crowdin API

Declaration

[PublicAPI]
public Task<ResponseList<TeamMember>> ListProjectMembers(long projectId, ProjectMembersListParams @params)

Parameters

Type	Name	Description
long	projectId
ProjectMembersListParams	params

Returns

Type	Description
Task<ResponseList<TeamMember>>

| Edit this page View Source

ListProjectMembers(long, string?, UserRole?, string?, int, int, IEnumerable<SortingRule>?)

List project members. Documentation: Crowdin API

Declaration

[PublicAPI]
public Task<ResponseList<TeamMember>> ListProjectMembers(long projectId, string? search = null, UserRole? role = null, string? languageId = null, int limit = 25, int offset = 0, IEnumerable<SortingRule>? orderBy = null)

Parameters

Type	Name	Description
long	projectId
string	search
UserRole?	role
string	languageId
int	limit
int	offset
IEnumerable<SortingRule>	orderBy

Returns

Type	Description
Task<ResponseList<TeamMember>>

| Edit this page View Source

ListProjectMembersEnterprise(long, EnterpriseProjectMembersListParams)

List project members. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<ProjectMember>> ListProjectMembersEnterprise(long projectId, EnterpriseProjectMembersListParams @params)

Parameters

Type	Name	Description
long	projectId
EnterpriseProjectMembersListParams	params

Returns

Type	Description
Task<ResponseList<ProjectMember>>

| Edit this page View Source

ListProjectMembersEnterprise(long, string?, string?, long?, int, int)

List project members. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<ProjectMember>> ListProjectMembersEnterprise(long projectId, string? search = null, string? languageId = null, long? workflowStepId = null, int limit = 25, int offset = 0)

Parameters

Type	Name	Description
long	projectId
string	search
string	languageId
long?	workflowStepId
int	limit
int	offset

Returns

Type	Description
Task<ResponseList<ProjectMember>>

| Edit this page View Source

ListUsers(EnterpriseUsersListParams)

List users. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<UserEnterprise>> ListUsers(EnterpriseUsersListParams @params)

Parameters

Type	Name	Description
EnterpriseUsersListParams	params

Returns

Type	Description
Task<ResponseList<UserEnterprise>>

| Edit this page View Source

ListUsers(UserStatus?, string?, UserTwoFactorStatus?, int, int, IEnumerable<SortingRule>?, IEnumerable<OrganizationRole>?, long?, IEnumerable<long>?, IEnumerable<ProjectRole>?, IEnumerable<string>?, IEnumerable<long>?, DateTimeOffset?, DateTimeOffset?)

List users. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public 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, long? teamId = null, IEnumerable<long>? projectIds = null, IEnumerable<ProjectRole>? projectRoles = null, IEnumerable<string>? languageIds = null, IEnumerable<long>? groupIds = null, DateTimeOffset? lastSeenFrom = null, DateTimeOffset? lastSeenTo = null)

Parameters

Type	Name	Description
UserStatus?	status
string	search
UserTwoFactorStatus?	twoFactor
int	limit
int	offset
IEnumerable<SortingRule>	orderBy
IEnumerable<OrganizationRole>	organizationRoles
long?	teamId
IEnumerable<long>	projectIds
IEnumerable<ProjectRole>	projectRoles
IEnumerable<string>	languageIds
IEnumerable<long>	groupIds
DateTimeOffset?	lastSeenFrom
DateTimeOffset?	lastSeenTo

Returns

Type	Description
Task<ResponseList<UserEnterprise>>

| Edit this page View Source

ReplaceProjectMemberPermissions(long, long, ReplaceProjectMemberPermissionsRequest)

Replace project member permissions. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ProjectMember> ReplaceProjectMemberPermissions(long projectId, long memberId, ReplaceProjectMemberPermissionsRequest request)

Parameters

Type	Name	Description
long	projectId
long	memberId
ReplaceProjectMemberPermissionsRequest	request

Returns

Type	Description
Task<ProjectMember>

| Edit this page View Source

UpdateGroupManagers(long, IEnumerable<GroupManagerPatch>)

Update Group Managers. Documentation: Crowdin Enterprise API

Declaration

[PublicAPI]
public Task<ResponseList<GroupManager>> UpdateGroupManagers(long groupId, IEnumerable<GroupManagerPatch> patches)

Parameters

Type	Name	Description
long	groupId
IEnumerable<GroupManagerPatch>	patches

Returns

Type	Description
Task<ResponseList<GroupManager>>

Implements

IUsersApiExecutor