UserSettings Class

Summary

Contains settings used by UserCreate.
graph BT Type-->Base0["ActiveDirectorySettings"] click Base0 "/api/Cake.ActiveDirectory/ActiveDirectorySettings" Base0-->Base1["Object"] Type["UserSettings"] class Type type-node

Syntax

public class UserSettings : ActiveDirectorySettings

Constructors

Name Summary
UserSettings()

Properties

Name Value Summary
Department string
Gets or sets the deparment of the user.
Description string
A description of the user.
DisplayName string
Gets or sets the display name of the user.
DomainName string
Active Directory domain name to operate on.
Email string
The user's email address.
EmployeeId string
Gets or sets the Employee Id.
EmployeeNumber string
Gets or sets the Employee Number.
FirstName string
Gets or set the first name of the user.
HomeDirectory string
The path to the user's home directory.
HomeDrive string
The user's home drive letter.
LastName string
Gets or sets the last name of the user.
LoginName string
LoginName for Active Directory Login
Manager string
Gets or sets the manager of the user.
MustChangePasswordNextLogon bool
Gets or sets if password needs changed on next logon.
Password string
Password for Active Directory Login.
PhoneNumber string
The user's telephone number.
StreetAddress string
The user's street address.
Title string
Gets or sets the title of the user.

Extension Methods

Name Value Summary
Dump<UserSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<UserSettings>(UserSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<UserSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<UserSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<UserSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<UserSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin