UserApi
extends AbstractApi
in package
Users API gives you the possibility to get profile information about the currently authenticated user.
Table of Contents
Methods
- addProjectMember() : ProjectMemberAddedStatistics
- Add Project Member
- createReportSettingsTemplate() : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
- Create User Report Settings Template
- deleteMemberFromProject() : void
- Delete Member From Project
- deleteReportSettingsTemplate() : void
- Delete User Report Settings Template
- get() : User
- getAuthenticatedUser() : User|null
- Get Authenticated User
- getProjectMemberInfo() : ProjectMember|null
- Get Member Info
- getReportSettingsTemplate() : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
- Get User Report Settings Template
- list() : ModelCollection
- listProjectMembers() : ModelCollection
- List Project Members
- listReportSettingsTemplates() : ModelCollection
- List User Report Settings Templates
- replaceProjectMemberPermissions() : ProjectMember|null
- Replace Project Member Permissions
- updateAuthenticatedUser() : User|null
- Update Authenticated User
- updateReportSettingsTemplate() : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
- Update User Report Settings Template
- makeUserReportSettingsTemplate() : HourlyUserReportSettingsTemplate|UserReportSettingsTemplate
Methods
addProjectMember()
Add Project Member
public
addProjectMember(int $projectId, array<string|int, mixed> $data) : ProjectMemberAddedStatistics
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
array $data[userIds]
array $data[usernames]
array $data[emails]
boolean $data[managerAccess]
boolean $data[developerAccess]
array $data[roles]
string $data[message]
Tags
Return values
ProjectMemberAddedStatisticscreateReportSettingsTemplate()
Create User Report Settings Template
public
createReportSettingsTemplate(int $userId, array<string|int, mixed> $data) : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
Parameters
- $userId : int
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[currency] required
string $data[unit] required
array $data[config] required
Tags
Return values
UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|nulldeleteMemberFromProject()
Delete Member From Project
public
deleteMemberFromProject(int $projectId, int $memberId) : void
Parameters
- $projectId : int
- $memberId : int
Tags
deleteReportSettingsTemplate()
Delete User Report Settings Template
public
deleteReportSettingsTemplate(int $userId, int $reportSettingsTemplateId) : void
Parameters
- $userId : int
- $reportSettingsTemplateId : int
Tags
get()
public
get(int $projectId, int $memberId) : User
This method returns wrong model. Use getProjectMemberInfo method instead.
Get Member Info
Parameters
- $projectId : int
- $memberId : int
Tags
Return values
UsergetAuthenticatedUser()
Get Authenticated User
public
getAuthenticatedUser() : User|null
Tags
Return values
User|nullgetProjectMemberInfo()
Get Member Info
public
getProjectMemberInfo(int $projectId, int $memberId) : ProjectMember|null
Parameters
- $projectId : int
- $memberId : int
Tags
Return values
ProjectMember|nullgetReportSettingsTemplate()
Get User Report Settings Template
public
getReportSettingsTemplate(int $userId, int $reportSettingsTemplateId) : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
Parameters
- $userId : int
- $reportSettingsTemplateId : int
Tags
Return values
UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|nulllist()
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
This method returns wrong model. Use listProjectMembers method instead.
List Project Members
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
string $params[search]
string $params[role]
string $params[languageId]
Tags
Return values
ModelCollectionlistProjectMembers()
List Project Members
public
listProjectMembers(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
string $params[search]
string $params[role]
string $params[languageId]
Tags
Return values
ModelCollectionlistReportSettingsTemplates()
List User Report Settings Templates
public
listReportSettingsTemplates(int $userId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $userId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionreplaceProjectMemberPermissions()
Replace Project Member Permissions
public
replaceProjectMemberPermissions(int $projectId, int $memberId, array<string|int, mixed> $data) : ProjectMember|null
Parameters
- $projectId : int
- $memberId : int
- $data : array<string|int, mixed>
-
boolean $data[managerAccess]
boolean $data[developerAccess]
array $data[roles]
Tags
Return values
ProjectMember|nullupdateAuthenticatedUser()
Update Authenticated User
public
updateAuthenticatedUser(User $user) : User|null
Parameters
- $user : User
Tags
Return values
User|nullupdateReportSettingsTemplate()
Update User Report Settings Template
public
updateReportSettingsTemplate(int $userId, UserReportSettingsTemplate|HourlyUserReportSettingsTemplate $reportSettingsTemplate) : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|null
Parameters
- $userId : int
- $reportSettingsTemplate : UserReportSettingsTemplate|HourlyUserReportSettingsTemplate
Tags
Return values
UserReportSettingsTemplate|HourlyUserReportSettingsTemplate|nullmakeUserReportSettingsTemplate()
private
makeUserReportSettingsTemplate(array<string|int, mixed> $data) : HourlyUserReportSettingsTemplate|UserReportSettingsTemplate
Parameters
- $data : array<string|int, mixed>