A class used to create new Users using the builder pattern. When all desired fields are set, call Post to create the user. More...

Public Member Functions
CreateUserBuilder	WithName (string name)
	The full name of the user. This name will be used by teacher for grading. Required if this is a self-registration. More...

CreateUserBuilder	WithShortName (string shortName)
	The user's name as it will be displayed in discussions, messages, and comments. More...

CreateUserBuilder	WithSortableName (string sortableName)
	The user's name as used to sort alphabetically in lists. More...

CreateUserBuilder	WithTimeZone (string timeZone)
	The time zone for the user. The allowed time zone formats are IANA time zones or Ruby on Rails time zones. More...

CreateUserBuilder	WithLocale (string locale)
	The user's preferred language, from the list of languages Canvas supports, in RFC-5646 format. More...

CreateUserBuilder	WithBirthDate (string date)
	The user's birth date. More...

CreateUserBuilder	WithTermsOfUseAccepted (bool hasAcceptedTerms=true)
	Whether the user accepts the terms of use. Required if this is a self-registration and this canvas instance requires users to accept the terms. More...

CreateUserBuilder	WithSkipRegistration (bool skipRegistration=true)
	Automatically mark the user as registered. If this is true, it is recommended to set WithSendConfirmation to true as well. More...

CreateUserBuilder	WithUniqueId (string uniqueId)
	The user's login ID. If this is a self-registration, it must be a valid email address. Always required. More...

CreateUserBuilder	WithPassword (string password)
	The user's password. Cannot be set during self-registration. More...

CreateUserBuilder	WithSisUserId (string sis)
	SIS ID for the user's account. To set this parameter, the caller must be able to manage SIS permissions. More...

CreateUserBuilder	WithIntegrationId (string integrationId)
	Integration ID for the login. To set this parameter, the caller must be able to manage SIS permissions. The Integration ID is a secondary identifier useful for more complex SIS integrations. More...

CreateUserBuilder	WithSendConfirmation (bool shouldSendConfirmation=true)
	Send user notification of account creation if true. Automatically set to true during self-registration. More...

CreateUserBuilder	WithForceSelfRegistration (bool shouldForceSelfRegistration=true)
	Send the user a self-registration email. More...

CreateUserBuilder	WithAuthProviderId (string authProviderId)
	The authentication provider this login is associated with. More...

CreateUserBuilder	WithCommunicationChannelType (string type)
	The communication channel type, e.g. 'email' or 'sms'. More...

CreateUserBuilder	WithCommunicationChannelAddress (string address)
	The communication channel address, e.g. the user's email address. More...

CreateUserBuilder	WithCommunicationChannelConfirmationUrl (bool returnUrl=true)
	Only valid for account admins. If true, returns the new user account confirmation URL in the response. More...

CreateUserBuilder	WithSkipCommunicationChannelConfirmation (bool skip=true)
	Only valid for site admins and account admins making requests. If true, the channel is automatically validated and no confirmation email or SMS is sent. Otherwise, the user must respond to a confirmation message to confirm the channel. More...

CreateUserBuilder	WithForceValidations (bool force=true)
	If true, validations are performed on the newly created user (and their associated pseudonym), even if the request is made by a privileged user like an admin. More...

CreateUserBuilder	WithSisReactivation (bool enable=true)
	When true, will first try to re-activate a deleted user with matching sis_user_id if possible. More...

CreateUserBuilder	WithDestination (string url)
	A canvas URL to be used as a redirect destination. More...

Task< User >	Post ()
	Creates a new user using the fields in this builder. More...

Detailed Description

A class used to create new Users using the builder pattern. When all desired fields are set, call Post to create the user.

Member Function Documentation

◆ Post()

Task<User> UVACanvasAccess.Builders.CreateUserBuilder.Post ( )

inline

Creates a new user using the fields in this builder.

Returns: The new user.

◆ WithAuthProviderId()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithAuthProviderId ( string authProviderId )

inline

The authentication provider this login is associated with.

Parameters

authProviderId

Returns: This builder.

◆ WithBirthDate()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithBirthDate ( string date )

inline

The user's birth date.

Parameters

date

Returns: This builder.

◆ WithCommunicationChannelAddress()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithCommunicationChannelAddress ( string address )

inline

The communication channel address, e.g. the user's email address.

Parameters

address

Returns: This builder.

◆ WithCommunicationChannelConfirmationUrl()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithCommunicationChannelConfirmationUrl ( bool returnUrl = true )

inline

Only valid for account admins. If true, returns the new user account confirmation URL in the response.

Parameters

returnUrl

Returns: This builder.

◆ WithCommunicationChannelType()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithCommunicationChannelType ( string type )

inline

The communication channel type, e.g. 'email' or 'sms'.

Parameters

type

Returns: This builder.

◆ WithDestination()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithDestination ( string url )

inline

A canvas URL to be used as a redirect destination.

Parameters

url

Returns: This builder.

◆ WithForceSelfRegistration()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithForceSelfRegistration ( bool shouldForceSelfRegistration = true )

inline

Send the user a self-registration email.

Parameters

shouldForceSelfRegistration

Returns: This builder.

◆ WithForceValidations()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithForceValidations ( bool force = true )

inline

If true, validations are performed on the newly created user (and their associated pseudonym), even if the request is made by a privileged user like an admin.

Parameters

force

Returns: This builder.

◆ WithIntegrationId()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithIntegrationId ( string integrationId )

inline

Integration ID for the login. To set this parameter, the caller must be able to manage SIS permissions. The Integration ID is a secondary identifier useful for more complex SIS integrations.

Parameters

integrationId

Returns: This builder.

◆ WithLocale()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithLocale ( string locale )

inline

The user's preferred language, from the list of languages Canvas supports, in RFC-5646 format.

Parameters

locale

Returns: This builder.

◆ WithName()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithName ( string name )

inline

The full name of the user. This name will be used by teacher for grading. Required if this is a self-registration.

Parameters

name

Returns: This builder.

◆ WithPassword()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithPassword ( string password )

inline

The user's password. Cannot be set during self-registration.

Parameters

password

Returns: This builder.

◆ WithSendConfirmation()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSendConfirmation ( bool shouldSendConfirmation = true )

inline

Send user notification of account creation if true. Automatically set to true during self-registration.

Parameters

shouldSendConfirmation

Returns: This builder.

◆ WithShortName()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithShortName ( string shortName )

inline

The user's name as it will be displayed in discussions, messages, and comments.

Parameters

shortName

Returns: This builder.

◆ WithSisReactivation()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSisReactivation ( bool enable = true )

inline

When true, will first try to re-activate a deleted user with matching sis_user_id if possible.

Parameters

enable

Returns: This builder.

◆ WithSisUserId()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSisUserId ( string sis )

inline

SIS ID for the user's account. To set this parameter, the caller must be able to manage SIS permissions.

Parameters

sis

Returns: This builder.

◆ WithSkipCommunicationChannelConfirmation()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSkipCommunicationChannelConfirmation ( bool skip = true )

inline

Only valid for site admins and account admins making requests. If true, the channel is automatically validated and no confirmation email or SMS is sent. Otherwise, the user must respond to a confirmation message to confirm the channel.

Parameters

skip

Returns: This builder.

◆ WithSkipRegistration()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSkipRegistration ( bool skipRegistration = true )

inline

Automatically mark the user as registered. If this is true, it is recommended to set WithSendConfirmation to true as well.

Parameters

skipRegistration

Returns: This builder.

◆ WithSortableName()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithSortableName ( string sortableName )

inline

The user's name as used to sort alphabetically in lists.

Parameters

sortableName

Returns: This builder.

◆ WithTermsOfUseAccepted()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithTermsOfUseAccepted ( bool hasAcceptedTerms = true )

inline

Whether the user accepts the terms of use. Required if this is a self-registration and this canvas instance requires users to accept the terms.

Parameters

hasAcceptedTerms

Returns: This builder.

◆ WithTimeZone()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithTimeZone ( string timeZone )

inline

The time zone for the user. The allowed time zone formats are IANA time zones or Ruby on Rails time zones.

Parameters

timeZone

Returns: This builder.

◆ WithUniqueId()

CreateUserBuilder UVACanvasAccess.Builders.CreateUserBuilder.WithUniqueId ( string uniqueId )

inline

The user's login ID. If this is a self-registration, it must be a valid email address. Always required.

Parameters

uniqueId

Returns: This builder.

The documentation for this class was generated from the following file:

UVACanvasAccess/Builders/CreateUserBuilder.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ Post()

◆ WithAuthProviderId()

◆ WithBirthDate()

◆ WithCommunicationChannelAddress()

◆ WithCommunicationChannelConfirmationUrl()

◆ WithCommunicationChannelType()

◆ WithDestination()

◆ WithForceSelfRegistration()

◆ WithForceValidations()

◆ WithIntegrationId()

◆ WithLocale()

◆ WithName()

◆ WithPassword()

◆ WithSendConfirmation()

◆ WithShortName()

◆ WithSisReactivation()

◆ WithSisUserId()

◆ WithSkipCommunicationChannelConfirmation()

◆ WithSkipRegistration()

◆ WithSortableName()

◆ WithTermsOfUseAccepted()

◆ WithTimeZone()

◆ WithUniqueId()