mattermost-mobile/detox/e2e/support/server_api/status.js
Joseph Baylon 53050595dd
MM-35355 Detox/E2E: Add e2e for channels settings (#5377)
* MM-35355 Detox/E2E: Add e2e for channels settings

* Added disabling of non prepackaged plugins to init

* Fix apiGetChannelByName doc parameter
2021-05-12 08:04:01 -07:00

60 lines
1.8 KiB
JavaScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import client from './client';
import {getResponseFromError} from './common';
// ****************************************************************
// Status
// See https://api.mattermost.com/#tag/status
//
// Exported API function should have the following:
// - documented using JSDoc
// - meaningful description
// - match the referenced API endpoints
// - parameter/s defined by `@param`
// - return value defined by `@return`
// ****************************************************************
/**
* Get user status.
* See https://api.mattermost.com/#operation/GetUserStatus
* @param {string} userId - the user ID
* @return {Object} returns {userStatus} on success or {error, status} on error
*/
export const apiGetUserStatus = async (userId) => {
try {
const response = await client.get(`/api/v4/users/${userId}/status`);
return {userStatus: response.data};
} catch (err) {
return getResponseFromError(err);
}
};
/**
* Update user status.
* See https://api.mattermost.com/#operation/UpdateUserStatus
* @param {string} userId - the user ID
* @param {string} status - the user status, can be online, away, offline and dnd
* @return {Object} returns {userStatus} on success or {error, status} on error
*/
export const apiUpdateUserStatus = async (userId, status = 'online') => {
try {
const response = await client.put(
`/api/v4/users/${userId}/status`,
{user_id: userId, status},
);
return {userStatus: response.data};
} catch (err) {
return getResponseFromError(err);
}
};
export const Status = {
apiGetUserStatus,
apiUpdateUserStatus,
};
export default Status;