getUserInfo(params: Object)

Requires:
BizKit≥3.0.0@ray-js/ray≥0.5.9
Platforms:
iOSAndroid
import { getUserInfo } from '@ray-js/ray';

// Promise usage
try {
  const res = await getUserInfo();
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Get user information

Parameters

PropertyTypeRequiredDescription
complete() => voidNoCompletion callback (executed on both success and failure)
success(params: Object) => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
success callback parameters
PropertyTypeDescriptionBizKit Since
nickNamestringnickName User nicknamev3.1.2
avatarUrlstringUser avatarv3.1.2
phoneCodestringPhone number country/region code Example: 86v3.1.2
regionCodestringServer region code for the user; see RegionCode Example: AYv4.12.13
isTemporaryUserbooleanWhether temporary userv3.1.2
timezoneIdstringUser time zone ID Example: Asia/Shanghaiv4.12.13
regFromnumberAccount registration method (ThingRegType)v4.12.13
tempUnitnumberUser temperature unit; see TempUnit: 1 for Celsius (°C), 2 for Fahrenheit (°F) Example: 1v4.12.13
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { getUserInfo } from '@ray-js/ray'

getUserInfo({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});