Module status_api

Source

Enums§

GetUserStatusError
struct for typed errors of method get_user_status
GetUsersStatusesByIdsError
struct for typed errors of method get_users_statuses_by_ids
PostUserRecentCustomStatusDeleteError
struct for typed errors of method post_user_recent_custom_status_delete
RemoveRecentCustomStatusError
struct for typed errors of method remove_recent_custom_status
UnsetUserCustomStatusError
struct for typed errors of method unset_user_custom_status
UpdateUserCustomStatusError
struct for typed errors of method update_user_custom_status
UpdateUserStatusError
struct for typed errors of method update_user_status

Functions§

get_user_status
Get user status by id from the server. ##### Permissions Must be authenticated.
get_users_statuses_by_ids
Get a list of user statuses by id from the server. ##### Permissions Must be authenticated.
post_user_recent_custom_status_delete
Deletes a user’s recent custom status by removing the specific status from the recentCustomStatuses in the user’s props and updates the user. ##### Permissions Must be logged in as the user whose recent custom status is being deleted.
remove_recent_custom_status
Deletes a user’s recent custom status by removing the specific status from the recentCustomStatuses in the user’s props and updates the user. ##### Permissions Must be logged in as the user whose recent custom status is being deleted.
unset_user_custom_status
Unsets a user’s custom status by updating the user’s props and updates the user ##### Permissions Must be logged in as the user whose custom status is being removed.
update_user_custom_status
Updates a user’s custom status by setting the value in the user’s props and updates the user. Also save the given custom status to the recent custom statuses in the user’s props ##### Permissions Must be logged in as the user whose custom status is being updated.
update_user_status
Manually set a user’s status. When setting a user’s status, the status will remain that value until set "online" again, which will return the status to being automatically updated based on user activity. ##### Permissions Must have edit_other_users permission for the team.