UserProvider.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2024, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

/**
 * A user provider is responsible for providing information about the currently
 * logged in user. This includes information about the user's roles, and whether
 * the user is currently logged in.
 */
export default class UserProvider {
  /**
   * @returns {Promise<User>} A promise that resolves with the currently logged in user
   */
  getCurrentUser() {}
  /**
   * @returns {boolean} true if a user is currently logged in, otherwise false
   */
  isLoggedIn() {}
  /**
   * @param {string} role
   * @returns {Promise<boolean>} true if the current user has the given role
   */
  hasRole(role) {}
}