클래스 User.ApiKeyClient

사용자가 클라이언트에서 API 키를 managed 수 있는 기능을 노출하는 클래스입니다. 항상 특정 사용자 로 범위가 지정되며 ApiKeys 를 통해서만 액세스할 수 있습니다.

상속

객체

User.ApiKeyClient

네임스페이스: Realms.동기화

어셈블리: Realm.exe

구문

public class User.ApiKeyClient

방법

CreateAsync(문자열)

사용자로 인증하는 데 사용할 수 있는 API 키를 생성합니다.

선언

public Task<ApiKey> CreateAsync(string name)

매개변수

유형	이름	설명
문자열	이름	키의 이름입니다.

반환

유형	설명
작업<ApiKey>	비동기 작업을 나타내는 대기 가능한 Task<TResult> 입니다. 성공적으로 완료되면 서버에 ApiKey 가 생성되었으며 해당 Value 를 사용하여 ApiKey(string) 을 생성할 수 있음을 나타냅니다.

비고

반환된 API 키의 값은 이때 유일하게 표시되므로 유지되어야 합니다. 키는 생성되면 활성화됩니다. DisableAsync(ObjectId) 를 호출하여 비활성화할 수 있습니다.

DeleteAsync(ObjectId)

ID로 API 키를 삭제합니다.

선언

public Task DeleteAsync(ObjectId id)

매개변수

유형	이름	설명
ObjectId	id	삭제할 키의 ID입니다.

반환

유형	설명
작업	비동기 삭제 작업 을 나타내는 대기 가능한 작업입니다.

DisableAsync(ObjectId)

ID별 API 키를 비활성화합니다.

선언

public Task DisableAsync(ObjectId id)

매개변수

유형	이름	설명
ObjectId	id	비활성화할 키의 ID입니다.

반환

유형	설명
작업	비동기 비활성화 작업 을 나타내는 대기 가능한 작업입니다.

다음도 참조하세요.

EnableAsync(ObjectId)

EnableAsync(ObjectId)

ID로 API 키를 활성화합니다.

선언

public Task EnableAsync(ObjectId id)

매개변수

유형	이름	설명
ObjectId	id	활성화할 키의 ID입니다.

반환

유형	설명
작업	비동기 활성화 작업 을 나타내는 대기 가능한 작업입니다.

다음도 참조하세요.

DisableAsync(ObjectId)

FatchAllAsync()

사용자와 연결된 모든 API 키를 가져옵니다.

선언

public Task<IEnumerable<ApiKey>> FetchAllAsync()

반환

유형	설명
작업 < IEnumerable < ApiKey >	비동기 조회 작업을 나타내는 대기 가능한 작업입니다. 완료되면 결과에 해당 사용자의 모든 API 키 collection이 포함됩니다.

FatchAsync(ObjectId)

ID로 특정 사용자 API 키를 가져옵니다.

선언

public Task<ApiKey?> FetchAsync(ObjectId id)

매개변수

유형	이름	설명
ObjectId	id	가져올 키의 ID입니다.

반환

유형	설명
작업<ApiKey>	비동기 조회 작업을 나타내는 대기 가능한 Task<TResult> 입니다.