UserClientBase

UserClientBase

クラス UserClientBase

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

ユーザーエンティティとユーザー関連のアクションをフェッチするためのクライアント。

継承

System.Object

UserClientBase

実装

IUsersClient

名前空間: Stylelabs.M.Sdk.Models.Clients

アセンブリ: Stylelabs.M.Sdk.dll

構文

public abstract class UserClientBase : object, IUsersClient

コンストラクター

UserClientBase(IMClient)

宣言

public UserClientBase(IMClient client)

パラメーター

型	名前	説明
IMClient	client

プロパティ

MClient

宣言

protected IMClient MClient { get; }

プロパティ値

型	説明
IMClient

メソッド

GetUserAsync(Int64, IEntityLoadConfiguration)

指定されたユーザーエンティティを取得します。

宣言

public virtual Task<IEntity> GetUserAsync(long id, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
System.Int64	id	ユーザーの ID。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IEntity>	ユーザーエンティティ。ユーザーエンティティが見つからなかった場合は null。

GetUserAsync(String, IEntityLoadConfiguration)

指定されたユーザーエンティティを取得します。

宣言

public virtual Task<IEntity> GetUserAsync(string username, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
System.String	username	ユーザーのユーザー名。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IEntity>	ユーザー。ユーザーが見つからなかった場合は null。

GetUserGroupAsync(Int64, IEntityLoadConfiguration)

指定されたユーザーグループエンティティを取得します。

宣言

public virtual Task<IEntity> GetUserGroupAsync(long id, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
System.Int64	id	ユーザーの ID。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IEntity>	ユーザー。ユーザーが見つからなかった場合は null。

GetUserGroupAsync(String, IEntityLoadConfiguration)

指定された名前でユーザーグループを取得します。

宣言

public virtual Task<IEntity> GetUserGroupAsync(string groupName, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
System.String	groupName	グループの名前。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IEntity>	ユーザーグループエンティティ。ユーザーグループエンティティが見つからなかった場合は null。

GetUserGroupIdAsync(String)

指定されたユーザーグループの ID を名前で取得します。

宣言

public virtual Task<long?> GetUserGroupIdAsync(string groupName)

パラメーター

型	名前	説明
System.String	groupName	groupName名。

戻り値

型	説明
Task<System.Nullable<System.Int64>>	グループの ID。ID が見つからなかった場合は null。

GetUserGroupIdsAsync(IEnumerable<String>)

指定されたユーザーグループの ID を名前で取得します。

宣言

public virtual Task<IDictionary<string, long>> GetUserGroupIdsAsync(IEnumerable<string> groupNames)

パラメーター

型	名前	説明
IEnumerable<System.String>	groupNames	グループ名のリスト。

戻り値

型	説明
Task<IDictionary<System.String, System.Int64>>	ユーザーグループ名を ID にマップする、null 以外の大文字と小文字を区別しないディクショナリ。存在しないユーザーは結果に含まれません。

GetUserGroupNameAsync(Int64)

指定されたユーザーグループの名前を取得します。

宣言

public virtual Task<string> GetUserGroupNameAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	ユーザーグループの ID。

戻り値

名前	説明
Task<System.String>	グループ名。グループ名が見つからなかった場合は null。

GetUserGroupNamesAsync(IEnumerable<Int64>)

指定されたユーザーグループ (複数) の名前を取得します。

宣言

public virtual Task<IDictionary<long, string>> GetUserGroupNamesAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids	ユーザーグループの ID。

戻り値

型	説明
Task<IDictionary<System.Int64, System.String>>	ユーザーグループ名をユーザーグループ ID にマップする、null 以外のディクショナリ。存在しないユーザーは結果に含まれません。

GetUserGroupsAsync(IEnumerable<Int64>, IEntityLoadConfiguration)

指定されたユーザーグループエンティティ (複数) を取得します。

宣言

public virtual Task<IList<IEntity>> GetUserGroupsAsync(IEnumerable<long> ids, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids	ユーザーグループの ID。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IList<IEntity>>	ユーザーグループエンティティ。ユーザーグループが見つからなかった場合は、null が含まれることがあります。

GetUserGroupsAsync(IEnumerable<String>, IEntityLoadConfiguration)

指定されたユーザーグループエンティティ (複数) を取得します。

宣言

public virtual Task<IList<IEntity>> GetUserGroupsAsync(IEnumerable<string> groupNames, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
IEnumerable<System.String>	groupNames	ユーザーグループの名前。
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IList<IEntity>>	ユーザーグループエンティティ。ユーザーグループが見つからなかった場合は、null が含まれることがあります。

GetUserIdAsync(String)

指定されたユーザーの ID を名前で取得します。

宣言

public virtual Task<long?> GetUserIdAsync(string username)

パラメーター

型	名前	説明
System.String	username	ユーザー名。

戻り値

型	説明
Task<System.Nullable<System.Int64>>	ユーザーの ID。ID が見つからなかった場合は null。

GetUserIdsAsync(IEnumerable<String>)

指定されたユーザーの ID をユーザー名で取得します。

宣言

public virtual Task<IDictionary<string, long>> GetUserIdsAsync(IEnumerable<string> usernames)

パラメーター

型	名前	説明
IEnumerable<System.String>	usernames	ユーザー名のリスト。

戻り値

型	説明
Task<IDictionary<System.String, System.Int64>>	ユーザー名を ID にマップする、null 以外の大文字と小文字を区別しないディクショナリ。存在しないユーザーは結果に含まれません。

GetUsernameAsync(Int64)

指定されたユーザーのユーザー名を取得します。

宣言

public virtual Task<string> GetUsernameAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	ユーザーの ID。

戻り値

型	説明
Task<System.String>	ユーザー名。ユーザー名が見つからなかった場合は null。

GetUsernamesAsync(IEnumerable<Int64>)

指定されたユーザー (複数) のユーザー名を取得します。

宣言

public virtual Task<IDictionary<long, string>> GetUsernamesAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids	取得するエンティティの ID (複数)。

戻り値

型	説明
Task<IDictionary<System.Int64, System.String>>	ユーザー ID をユーザー名にマップする、null 以外のディクショナリ。存在しないユーザーは結果に含まれません。

GetUsersAsync(IEnumerable<Int64>, IEntityLoadConfiguration)

指定されたユーザーエンティティ (複数) を取得します。

宣言

public virtual Task<IList<IEntity>> GetUsersAsync(IEnumerable<long> ids, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids
IEntityLoadConfiguration	loadConfiguration	読み込み設定。

戻り値

型	説明
Task<IList<IEntity>>	ユーザーエンティティ。ユーザーが見つからなかった場合は、null が含まれることがあります。

GetUsersAsync(IEnumerable<String>, IEntityLoadConfiguration)

宣言

public virtual Task<IList<IEntity>> GetUsersAsync(IEnumerable<string> usernames, IEntityLoadConfiguration loadConfiguration = null)

パラメーター

型	名前	説明
IEnumerable<System.String>	usernames
IEntityLoadConfiguration	loadConfiguration

戻り値

型	説明
Task<IList<IEntity>>

ResetPasswordAsync(Int64)

指定したユーザーのパスワードをリセットします。これにより、新しいパスワードを選択するためのリンクが記載された電子メールが指定されたユーザーに送信されます。

宣言

public abstract Task ResetPasswordAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	ユーザーの ID。

戻り値

型	説明
Task	A 表すタスク。

例外

型	条件
ForbiddenException	現在のユーザーがスーパーユーザーでない場合。

SetPasswordAsync(Int64, String)

指定したユーザーのパスワードを変更します。

宣言

public abstract Task SetPasswordAsync(long id, string password)

パラメーター

型	名前	説明
System.Int64	id	パスワードを変更するユーザー ID。
System.String	password	リセットするパスワード。

戻り値

型	説明
Task	A 表すタスク。

例外

型	条件
ForbiddenException	現在のユーザーがスーパーユーザーでない場合。

実装

IUsersClient

この記事を改善するための提案がある場合は、お知らせください!