클래스 User<UserFunctionsFactoryType, UserCustomDataType, UserProfileDataType>

의 인증된 사용자를 나타냅니다.

유형 매개변수

접근자

  • accessToken( )가져오기: null | 문자열
  • 새 액세스 토큰을 요청할 때 사용되는 액세스 토큰입니다.

    null반환 | 문자열

    문자열 또는 null 인 액세스 토큰.

  • get customData(): UserCustomDataType
  • 애플리케이션 사용자에 대한 임의의 데이터를 MongoDB collection에 저장하고 각 사용자의 데이터를 사용자 객체의 필드에 자동으로 노출하도록 Atlas App Services를 구성할 수 있습니다. 예를 들어 사용자의 기본 설정 언어, 생년월일 또는 현지 시간대를 저장할 수 있습니다.

    이 값이 구성되지 않은 경우 이 값은 비어 있습니다.

    반환 값 UserCustomDataType

    사용자 지정 데이터를 객체로 표시합니다.

  • get providerType(): ProviderType
  • 사용자를 인증할 때 사용되는 제공자 유형입니다. ID가 여러 개 있는 경우 가장 먼저 발견된 ID에 대한 공급자 유형이 반환됩니다.

    반환 값 제공자 유형

    제공자 유형(열거형 문자열)입니다.

    더 이상 사용되지 않습니다.

    대신 ID 를 사용하세요.

  • get refreshToken(): null | 문자열
  • 새 액세스 토큰을 요청할 때 사용되는 새로 고침 토큰입니다.

    null반환 | 문자열

    문자열 또는 null 인 새로 고침 토큰.

방법

  • 다양한 사용자 관련 이벤트에서 실행될 리스너를 추가합니다. 여기에는 인증 토큰 새로 고침, 토큰 새로 고침, 사용자 지정 사용자 데이터 새로 고침 및 로그아웃이 포함됩니다.

    매개변수

    반환 값 void

  • 이름으로 원격 Atlas App Services 함수를 호출합니다.

    매개변수

    • name: 문자열

      App Services 함수의 이름입니다.

    • Rest ...args: 알 수 없음[]

      함수에 전달된 인수입니다.

    Promise<알 수 없음>반환

    함수가 반환한 값으로 확인되는 promise입니다.

    참고

    이 메서드를 호출하는 대신 functions[name]() 을(를) 사용하는 것이 좋습니다.

    예시

    // These are all equivalent:
    await user.callFunction("doThing", a1, a2, a3);
    await user.functions.doThing(a1, a2, a3);
    await user.functions["doThing"](a1, a2, a3);

    예시

    // The methods returned from the functions object are bound, which is why it's okay to store the function in a variable before calling it:
    const doThing = user.functions.doThing;
    await doThing(a1);
    await doThing(a2);
  • 사용자를 다른 자격 증명 세트로 표시되는 ID와 연결합니다.

    매개변수

    • credentials: 자격 증명

      연결할 때 사용할 자격 증명입니다.

    Promise<void>를 반환합니다.

    사용자가 자격 증명과 연결되면 해결되는 프로미스입니다.

  • 사용자를 로그아웃합니다.

    Promise<void>를 반환합니다.

    사용자가 앱에서 로그아웃하면 해결되는 프로미스입니다.

  • 매개변수

    • serviceName: 문자열

      연결할 MongoDB 서비스의 이름입니다.

    반환 값 MongoDB

    MongoDB 서비스에 대한 액세스를 활성화하는 클라이언트입니다.

    예시

    let blueWidgets = user.mongoClient("myService")
    .db("myDb")
    .collection<Widget>("widgets")
    .find({ color: "blue" });

TypeDoc을 사용하여 생성됨