@handcash/handcash-connect/dist/types/profile/index.d.ts

HandCash Connect SDK

import HandCashConnectService from '../api/handcash_connect_service';
import { Permission, PermissionInfo, UserProfile, UserPublicProfile } from '../types/account';
import { DataSignature, DataSignatureParameters } from '../types/signature';
export default class Profile {
    handCashConnectService: HandCashConnectService;
    constructor(handCashConnectService: HandCashConnectService);
    /**
     *
     * Gets the full profile of the user with his public and private profile.
     *
     * @returns {Promise<UserProfile>} A promise that resolves to the user profile.
     */
    getCurrentProfile(): Promise<UserProfile>;
    /**
     *
     * Gets the public profile of any handcash user.
     *
     * @param {string[]} handles - The user handles.
     *
     * @returns {Promise<UserPublicProfile[]>} A promise that resolves to the public profiles of the users.
     *
     */
    getPublicProfilesByHandle(handles: string[]): Promise<UserPublicProfile[]>;
    /**
     *
     * Returns a list of the user's friends amd their public profiles.
     * Requires the FRIENDS permission.
     *
     * @returns {Promise<UserPublicProfile[]>} A promise that resolves to the public profiles of the user's friends.
     */
    getFriends(): Promise<UserPublicProfile[]>;
    /**
     *
     * Returns the permissions granted to the app by the user.
     *
     * @returns {Promise<Permission[]>} A promise that resolves to the user's permissions.
     *
     */
    getPermissions(): Promise<Permission[]>;
    /**
     *
     * Returns the permissions granted to the app by the user along with the app id.
     *
     * @returns {Promise<PermissionInfo>} A promise that resolves to PermissionsInfo.
     *
     */
    getPermissionsInfo(): Promise<PermissionInfo>;
    /**
     *
     * Signs a message with the user's private key.
     * Requires the SIGN_DATA permission.
     *
     * @param {Object} dataSignatureParameters - The data to sign.
     * @param {string} dataSignatureParameters.value - The value of the data.
     * @param {string} dataSignatureParameters.format - The format of the data. Can be 'utf-8', 'base64' or 'hex'.
     *
     * @returns {Promise<DataSignature>} A promise that resolves to the data signature.
     *
     */
    signData(dataSignatureParameters: DataSignatureParameters): Promise<DataSignature>;
}