Class: MicrosoftGraph::Models::EducationUser

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/education_user.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initializeObject

Instantiates a new educationUser and sets the default values.



218
219
220
# File 'lib/models/education_user.rb', line 218

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a education_user

Raises:

  • (StandardError)


241
242
243
244
# File 'lib/models/education_user.rb', line 241

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return EducationUser.new
end

Instance Method Details

#account_enabledObject

Gets the accountEnabled property value. True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter.

Returns:

  • a boolean



128
129
130
# File 'lib/models/education_user.rb', line 128

def 
    return @account_enabled
end

#account_enabled=(value) ⇒ Object

Sets the accountEnabled property value. True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter.

Parameters:

  • value

    Value to set for the accountEnabled property.

Returns:

  • a void



136
137
138
# File 'lib/models/education_user.rb', line 136

def (value)
    @account_enabled = value
end

#assigned_licensesObject

Gets the assignedLicenses property value. The licenses that are assigned to the user. Not nullable.

Returns:

  • a assigned_license



143
144
145
# File 'lib/models/education_user.rb', line 143

def assigned_licenses
    return @assigned_licenses
end

#assigned_licenses=(value) ⇒ Object

Sets the assignedLicenses property value. The licenses that are assigned to the user. Not nullable.

Parameters:

  • value

    Value to set for the assignedLicenses property.

Returns:

  • a void



151
152
153
# File 'lib/models/education_user.rb', line 151

def assigned_licenses=(value)
    @assigned_licenses = value
end

#assigned_plansObject

Gets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable.

Returns:

  • a assigned_plan



158
159
160
# File 'lib/models/education_user.rb', line 158

def assigned_plans
    return @assigned_plans
end

#assigned_plans=(value) ⇒ Object

Sets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable.

Parameters:

  • value

    Value to set for the assignedPlans property.

Returns:

  • a void



166
167
168
# File 'lib/models/education_user.rb', line 166

def assigned_plans=(value)
    @assigned_plans = value
end

#assignmentsObject

Gets the assignments property value. Assignments belonging to the user.

Returns:

  • a education_assignment



173
174
175
# File 'lib/models/education_user.rb', line 173

def assignments
    return @assignments
end

#assignments=(value) ⇒ Object

Sets the assignments property value. Assignments belonging to the user.

Parameters:

  • value

    Value to set for the assignments property.

Returns:

  • a void



181
182
183
# File 'lib/models/education_user.rb', line 181

def assignments=(value)
    @assignments = value
end

#business_phonesObject

Gets the businessPhones property value. The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property.

Returns:

  • a string



188
189
190
# File 'lib/models/education_user.rb', line 188

def business_phones
    return @business_phones
end

#business_phones=(value) ⇒ Object

Sets the businessPhones property value. The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property.

Parameters:

  • value

    Value to set for the businessPhones property.

Returns:

  • a void



196
197
198
# File 'lib/models/education_user.rb', line 196

def business_phones=(value)
    @business_phones = value
end

#classesObject

Gets the classes property value. Classes to which the user belongs. Nullable.

Returns:

  • a education_class



203
204
205
# File 'lib/models/education_user.rb', line 203

def classes
    return @classes
end

#classes=(value) ⇒ Object

Sets the classes property value. Classes to which the user belongs. Nullable.

Parameters:

  • value

    Value to set for the classes property.

Returns:

  • a void



211
212
213
# File 'lib/models/education_user.rb', line 211

def classes=(value)
    @classes = value
end

#created_byObject

Gets the createdBy property value. The entity who created the user.

Returns:

  • a identity_set



225
226
227
# File 'lib/models/education_user.rb', line 225

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. The entity who created the user.

Parameters:

  • value

    Value to set for the createdBy property.

Returns:

  • a void



233
234
235
# File 'lib/models/education_user.rb', line 233

def created_by=(value)
    @created_by = value
end

#departmentObject

Gets the department property value. The name for the department in which the user works. Supports $filter.

Returns:

  • a string



249
250
251
# File 'lib/models/education_user.rb', line 249

def department
    return @department
end

#department=(value) ⇒ Object

Sets the department property value. The name for the department in which the user works. Supports $filter.

Parameters:

  • value

    Value to set for the department property.

Returns:

  • a void



257
258
259
# File 'lib/models/education_user.rb', line 257

def department=(value)
    @department = value
end

#display_nameObject

Gets the displayName property value. The name displayed in the address book for the user. This is usually the combination of the user’s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby.

Returns:

  • a string



264
265
266
# File 'lib/models/education_user.rb', line 264

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The name displayed in the address book for the user. This is usually the combination of the user’s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby.

Parameters:

  • value

    Value to set for the displayName property.

Returns:

  • a void



272
273
274
# File 'lib/models/education_user.rb', line 272

def display_name=(value)
    @display_name = value
end

#external_sourceObject

Gets the externalSource property value. Where this user was created from. Possible values are: sis, manual.

Returns:

  • a education_external_source



279
280
281
# File 'lib/models/education_user.rb', line 279

def external_source
    return @external_source
end

#external_source=(value) ⇒ Object

Sets the externalSource property value. Where this user was created from. Possible values are: sis, manual.

Parameters:

  • value

    Value to set for the externalSource property.

Returns:

  • a void



287
288
289
# File 'lib/models/education_user.rb', line 287

def external_source=(value)
    @external_source = value
end

#external_source_detailObject

Gets the externalSourceDetail property value. The name of the external source this resource was generated from.

Returns:

  • a string



294
295
296
# File 'lib/models/education_user.rb', line 294

def external_source_detail
    return @external_source_detail
end

#external_source_detail=(value) ⇒ Object

Sets the externalSourceDetail property value. The name of the external source this resource was generated from.

Parameters:

  • value

    Value to set for the externalSourceDetail property.

Returns:

  • a void



302
303
304
# File 'lib/models/education_user.rb', line 302

def external_source_detail=(value)
    @external_source_detail = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/models/education_user.rb', line 309

def get_field_deserializers()
    return super.merge({
        "accountEnabled" => lambda {|n| @account_enabled = n.get_boolean_value() },
        "assignedLicenses" => lambda {|n| @assigned_licenses = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedLicense.create_from_discriminator_value(pn) }) },
        "assignedPlans" => lambda {|n| @assigned_plans = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AssignedPlan.create_from_discriminator_value(pn) }) },
        "assignments" => lambda {|n| @assignments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationAssignment.create_from_discriminator_value(pn) }) },
        "businessPhones" => lambda {|n| @business_phones = n.get_collection_of_primitive_values(String) },
        "classes" => lambda {|n| @classes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationClass.create_from_discriminator_value(pn) }) },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "department" => lambda {|n| @department = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "externalSource" => lambda {|n| @external_source = n.get_enum_value(MicrosoftGraph::Models::EducationExternalSource) },
        "externalSourceDetail" => lambda {|n| @external_source_detail = n.get_string_value() },
        "givenName" => lambda {|n| @given_name = n.get_string_value() },
        "mail" => lambda {|n| @mail = n.get_string_value() },
        "mailNickname" => lambda {|n| @mail_nickname = n.get_string_value() },
        "mailingAddress" => lambda {|n| @mailing_address = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PhysicalAddress.create_from_discriminator_value(pn) }) },
        "middleName" => lambda {|n| @middle_name = n.get_string_value() },
        "mobilePhone" => lambda {|n| @mobile_phone = n.get_string_value() },
        "officeLocation" => lambda {|n| @office_location = n.get_string_value() },
        "onPremisesInfo" => lambda {|n| @on_premises_info = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationOnPremisesInfo.create_from_discriminator_value(pn) }) },
        "passwordPolicies" => lambda {|n| @password_policies = n.get_string_value() },
        "passwordProfile" => lambda {|n| @password_profile = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PasswordProfile.create_from_discriminator_value(pn) }) },
        "preferredLanguage" => lambda {|n| @preferred_language = n.get_string_value() },
        "primaryRole" => lambda {|n| @primary_role = n.get_enum_value(MicrosoftGraph::Models::EducationUserRole) },
        "provisionedPlans" => lambda {|n| @provisioned_plans = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ProvisionedPlan.create_from_discriminator_value(pn) }) },
        "refreshTokensValidFromDateTime" => lambda {|n| @refresh_tokens_valid_from_date_time = n.get_date_time_value() },
        "relatedContacts" => lambda {|n| @related_contacts = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::RelatedContact.create_from_discriminator_value(pn) }) },
        "residenceAddress" => lambda {|n| @residence_address = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PhysicalAddress.create_from_discriminator_value(pn) }) },
        "rubrics" => lambda {|n| @rubrics = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationRubric.create_from_discriminator_value(pn) }) },
        "schools" => lambda {|n| @schools = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationSchool.create_from_discriminator_value(pn) }) },
        "showInAddressList" => lambda {|n| @show_in_address_list = n.get_boolean_value() },
        "student" => lambda {|n| @student = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationStudent.create_from_discriminator_value(pn) }) },
        "surname" => lambda {|n| @surname = n.get_string_value() },
        "taughtClasses" => lambda {|n| @taught_classes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationClass.create_from_discriminator_value(pn) }) },
        "teacher" => lambda {|n| @teacher = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationTeacher.create_from_discriminator_value(pn) }) },
        "usageLocation" => lambda {|n| @usage_location = n.get_string_value() },
        "user" => lambda {|n| @user = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::User.create_from_discriminator_value(pn) }) },
        "userPrincipalName" => lambda {|n| @user_principal_name = n.get_string_value() },
        "userType" => lambda {|n| @user_type = n.get_string_value() },
    })
end

#given_nameObject

Gets the givenName property value. The given name (first name) of the user. Supports $filter.

Returns:

  • a string



355
356
357
# File 'lib/models/education_user.rb', line 355

def given_name
    return @given_name
end

#given_name=(value) ⇒ Object

Sets the givenName property value. The given name (first name) of the user. Supports $filter.

Parameters:

  • value

    Value to set for the givenName property.

Returns:

  • a void



363
364
365
# File 'lib/models/education_user.rb', line 363

def given_name=(value)
    @given_name = value
end

#mailObject

Gets the mail property value. The SMTP address for the user, for example, [email protected]. Read-Only. Supports $filter.

Returns:

  • a string



370
371
372
# File 'lib/models/education_user.rb', line 370

def mail
    return @mail
end

#mail=(value) ⇒ Object

Sets the mail property value. The SMTP address for the user, for example, [email protected]. Read-Only. Supports $filter.

Parameters:

  • value

    Value to set for the mail property.

Returns:

  • a void



378
379
380
# File 'lib/models/education_user.rb', line 378

def mail=(value)
    @mail = value
end

#mail_nicknameObject

Gets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Supports $filter.

Returns:

  • a string



385
386
387
# File 'lib/models/education_user.rb', line 385

def mail_nickname
    return @mail_nickname
end

#mail_nickname=(value) ⇒ Object

Sets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Supports $filter.

Parameters:

  • value

    Value to set for the mailNickname property.

Returns:

  • a void



393
394
395
# File 'lib/models/education_user.rb', line 393

def mail_nickname=(value)
    @mail_nickname = value
end

#mailing_addressObject

Gets the mailingAddress property value. The mail address of the user.

Returns:

  • a physical_address



400
401
402
# File 'lib/models/education_user.rb', line 400

def mailing_address
    return @mailing_address
end

#mailing_address=(value) ⇒ Object

Sets the mailingAddress property value. The mail address of the user.

Parameters:

  • value

    Value to set for the mailingAddress property.

Returns:

  • a void



408
409
410
# File 'lib/models/education_user.rb', line 408

def mailing_address=(value)
    @mailing_address = value
end

#middle_nameObject

Gets the middleName property value. The middle name of the user.

Returns:

  • a string



415
416
417
# File 'lib/models/education_user.rb', line 415

def middle_name
    return @middle_name
end

#middle_name=(value) ⇒ Object

Sets the middleName property value. The middle name of the user.

Parameters:

  • value

    Value to set for the middleName property.

Returns:

  • a void



423
424
425
# File 'lib/models/education_user.rb', line 423

def middle_name=(value)
    @middle_name = value
end

#mobile_phoneObject

Gets the mobilePhone property value. The primary cellular telephone number for the user.

Returns:

  • a string



430
431
432
# File 'lib/models/education_user.rb', line 430

def mobile_phone
    return @mobile_phone
end

#mobile_phone=(value) ⇒ Object

Sets the mobilePhone property value. The primary cellular telephone number for the user.

Parameters:

  • value

    Value to set for the mobilePhone property.

Returns:

  • a void



438
439
440
# File 'lib/models/education_user.rb', line 438

def mobile_phone=(value)
    @mobile_phone = value
end

#office_locationObject

Gets the officeLocation property value. The officeLocation property

Returns:

  • a string



445
446
447
# File 'lib/models/education_user.rb', line 445

def office_location
    return @office_location
end

#office_location=(value) ⇒ Object

Sets the officeLocation property value. The officeLocation property

Parameters:

  • value

    Value to set for the officeLocation property.

Returns:

  • a void



453
454
455
# File 'lib/models/education_user.rb', line 453

def office_location=(value)
    @office_location = value
end

#on_premises_infoObject

Gets the onPremisesInfo property value. Additional information used to associate the Azure Active Directory user with its Active Directory counterpart.

Returns:

  • a education_on_premises_info



460
461
462
# File 'lib/models/education_user.rb', line 460

def on_premises_info
    return @on_premises_info
end

#on_premises_info=(value) ⇒ Object

Sets the onPremisesInfo property value. Additional information used to associate the Azure Active Directory user with its Active Directory counterpart.

Parameters:

  • value

    Value to set for the onPremisesInfo property.

Returns:

  • a void



468
469
470
# File 'lib/models/education_user.rb', line 468

def on_premises_info=(value)
    @on_premises_info = value
end

#password_policiesObject

Gets the passwordPolicies property value. Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two can be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

Returns:

  • a string



475
476
477
# File 'lib/models/education_user.rb', line 475

def password_policies
    return @password_policies
end

#password_policies=(value) ⇒ Object

Sets the passwordPolicies property value. Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two can be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

Parameters:

  • value

    Value to set for the passwordPolicies property.

Returns:

  • a void



483
484
485
# File 'lib/models/education_user.rb', line 483

def password_policies=(value)
    @password_policies = value
end

#password_profileObject

Gets the passwordProfile property value. Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

Returns:

  • a password_profile



490
491
492
# File 'lib/models/education_user.rb', line 490

def password_profile
    return @password_profile
end

#password_profile=(value) ⇒ Object

Sets the passwordProfile property value. Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

Parameters:

  • value

    Value to set for the passwordProfile property.

Returns:

  • a void



498
499
500
# File 'lib/models/education_user.rb', line 498

def password_profile=(value)
    @password_profile = value
end

#preferred_languageObject

Gets the preferredLanguage property value. The preferred language for the user that should follow the ISO 639-1 code, for example, en-US.

Returns:

  • a string



505
506
507
# File 'lib/models/education_user.rb', line 505

def preferred_language
    return @preferred_language
end

#preferred_language=(value) ⇒ Object

Sets the preferredLanguage property value. The preferred language for the user that should follow the ISO 639-1 code, for example, en-US.

Parameters:

  • value

    Value to set for the preferredLanguage property.

Returns:

  • a void



513
514
515
# File 'lib/models/education_user.rb', line 513

def preferred_language=(value)
    @preferred_language = value
end

#primary_roleObject

Gets the primaryRole property value. The primaryRole property

Returns:

  • a education_user_role



520
521
522
# File 'lib/models/education_user.rb', line 520

def primary_role
    return @primary_role
end

#primary_role=(value) ⇒ Object

Sets the primaryRole property value. The primaryRole property

Parameters:

  • value

    Value to set for the primaryRole property.

Returns:

  • a void



528
529
530
# File 'lib/models/education_user.rb', line 528

def primary_role=(value)
    @primary_role = value
end

#provisioned_plansObject

Gets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable.

Returns:

  • a provisioned_plan



535
536
537
# File 'lib/models/education_user.rb', line 535

def provisioned_plans
    return @provisioned_plans
end

#provisioned_plans=(value) ⇒ Object

Sets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable.

Parameters:

  • value

    Value to set for the provisionedPlans property.

Returns:

  • a void



543
544
545
# File 'lib/models/education_user.rb', line 543

def provisioned_plans=(value)
    @provisioned_plans = value
end

#refresh_tokens_valid_from_date_timeObject

Gets the refreshTokensValidFromDateTime property value. The refreshTokensValidFromDateTime property

Returns:

  • a date_time



550
551
552
# File 'lib/models/education_user.rb', line 550

def refresh_tokens_valid_from_date_time
    return @refresh_tokens_valid_from_date_time
end

#refresh_tokens_valid_from_date_time=(value) ⇒ Object

Sets the refreshTokensValidFromDateTime property value. The refreshTokensValidFromDateTime property

Parameters:

  • value

    Value to set for the refreshTokensValidFromDateTime property.

Returns:

  • a void



558
559
560
# File 'lib/models/education_user.rb', line 558

def refresh_tokens_valid_from_date_time=(value)
    @refresh_tokens_valid_from_date_time = value
end

Gets the relatedContacts property value. Related records associated with the user. Read-only.

Returns:

  • a related_contact



565
566
567
# File 'lib/models/education_user.rb', line 565

def related_contacts
    return @related_contacts
end

Sets the relatedContacts property value. Related records associated with the user. Read-only.

Parameters:

  • value

    Value to set for the relatedContacts property.

Returns:

  • a void



573
574
575
# File 'lib/models/education_user.rb', line 573

def related_contacts=(value)
    @related_contacts = value
end

#residence_addressObject

Gets the residenceAddress property value. The address where the user lives.

Returns:

  • a physical_address



580
581
582
# File 'lib/models/education_user.rb', line 580

def residence_address
    return @residence_address
end

#residence_address=(value) ⇒ Object

Sets the residenceAddress property value. The address where the user lives.

Parameters:

  • value

    Value to set for the residenceAddress property.

Returns:

  • a void



588
589
590
# File 'lib/models/education_user.rb', line 588

def residence_address=(value)
    @residence_address = value
end

#rubricsObject

Gets the rubrics property value. When set, the grading rubric attached to the assignment.

Returns:

  • a education_rubric



595
596
597
# File 'lib/models/education_user.rb', line 595

def rubrics
    return @rubrics
end

#rubrics=(value) ⇒ Object

Sets the rubrics property value. When set, the grading rubric attached to the assignment.

Parameters:

  • value

    Value to set for the rubrics property.

Returns:

  • a void



603
604
605
# File 'lib/models/education_user.rb', line 603

def rubrics=(value)
    @rubrics = value
end

#schoolsObject

Gets the schools property value. Schools to which the user belongs. Nullable.

Returns:

  • a education_school



610
611
612
# File 'lib/models/education_user.rb', line 610

def schools
    return @schools
end

#schools=(value) ⇒ Object

Sets the schools property value. Schools to which the user belongs. Nullable.

Parameters:

  • value

    Value to set for the schools property.

Returns:

  • a void



618
619
620
# File 'lib/models/education_user.rb', line 618

def schools=(value)
    @schools = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
# File 'lib/models/education_user.rb', line 626

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_boolean_value("accountEnabled", @account_enabled)
    writer.write_collection_of_object_values("assignedLicenses", @assigned_licenses)
    writer.write_collection_of_object_values("assignedPlans", @assigned_plans)
    writer.write_collection_of_object_values("assignments", @assignments)
    writer.write_collection_of_primitive_values("businessPhones", @business_phones)
    writer.write_collection_of_object_values("classes", @classes)
    writer.write_object_value("createdBy", @created_by)
    writer.write_string_value("department", @department)
    writer.write_string_value("displayName", @display_name)
    writer.write_enum_value("externalSource", @external_source)
    writer.write_string_value("externalSourceDetail", @external_source_detail)
    writer.write_string_value("givenName", @given_name)
    writer.write_string_value("mail", @mail)
    writer.write_string_value("mailNickname", @mail_nickname)
    writer.write_object_value("mailingAddress", @mailing_address)
    writer.write_string_value("middleName", @middle_name)
    writer.write_string_value("mobilePhone", @mobile_phone)
    writer.write_string_value("officeLocation", @office_location)
    writer.write_object_value("onPremisesInfo", @on_premises_info)
    writer.write_string_value("passwordPolicies", @password_policies)
    writer.write_object_value("passwordProfile", @password_profile)
    writer.write_string_value("preferredLanguage", @preferred_language)
    writer.write_enum_value("primaryRole", @primary_role)
    writer.write_collection_of_object_values("provisionedPlans", @provisioned_plans)
    writer.write_date_time_value("refreshTokensValidFromDateTime", @refresh_tokens_valid_from_date_time)
    writer.write_collection_of_object_values("relatedContacts", @related_contacts)
    writer.write_object_value("residenceAddress", @residence_address)
    writer.write_collection_of_object_values("rubrics", @rubrics)
    writer.write_collection_of_object_values("schools", @schools)
    writer.write_boolean_value("showInAddressList", @show_in_address_list)
    writer.write_object_value("student", @student)
    writer.write_string_value("surname", @surname)
    writer.write_collection_of_object_values("taughtClasses", @taught_classes)
    writer.write_object_value("teacher", @teacher)
    writer.write_string_value("usageLocation", @usage_location)
    writer.write_object_value("user", @user)
    writer.write_string_value("userPrincipalName", @user_principal_name)
    writer.write_string_value("userType", @user_type)
end

#show_in_address_listObject

Gets the showInAddressList property value. True if the Outlook Global Address List should contain this user; otherwise, false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false.

Returns:

  • a boolean



672
673
674
# File 'lib/models/education_user.rb', line 672

def show_in_address_list
    return @show_in_address_list
end

#show_in_address_list=(value) ⇒ Object

Sets the showInAddressList property value. True if the Outlook Global Address List should contain this user; otherwise, false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false.

Parameters:

  • value

    Value to set for the showInAddressList property.

Returns:

  • a void



680
681
682
# File 'lib/models/education_user.rb', line 680

def show_in_address_list=(value)
    @show_in_address_list = value
end

#studentObject

Gets the student property value. If the primary role is student, this block will contain student specific data.

Returns:

  • a education_student



687
688
689
# File 'lib/models/education_user.rb', line 687

def student
    return @student
end

#student=(value) ⇒ Object

Sets the student property value. If the primary role is student, this block will contain student specific data.

Parameters:

  • value

    Value to set for the student property.

Returns:

  • a void



695
696
697
# File 'lib/models/education_user.rb', line 695

def student=(value)
    @student = value
end

#surnameObject

Gets the surname property value. The user’s surname (family name or last name). Supports $filter.

Returns:

  • a string



702
703
704
# File 'lib/models/education_user.rb', line 702

def surname
    return @surname
end

#surname=(value) ⇒ Object

Sets the surname property value. The user’s surname (family name or last name). Supports $filter.

Parameters:

  • value

    Value to set for the surname property.

Returns:

  • a void



710
711
712
# File 'lib/models/education_user.rb', line 710

def surname=(value)
    @surname = value
end

#taught_classesObject

Gets the taughtClasses property value. Classes for which the user is a teacher.

Returns:

  • a education_class



717
718
719
# File 'lib/models/education_user.rb', line 717

def taught_classes
    return @taught_classes
end

#taught_classes=(value) ⇒ Object

Sets the taughtClasses property value. Classes for which the user is a teacher.

Parameters:

  • value

    Value to set for the taughtClasses property.

Returns:

  • a void



725
726
727
# File 'lib/models/education_user.rb', line 725

def taught_classes=(value)
    @taught_classes = value
end

#teacherObject

Gets the teacher property value. If the primary role is teacher, this block will contain teacher specific data.

Returns:

  • a education_teacher



732
733
734
# File 'lib/models/education_user.rb', line 732

def teacher
    return @teacher
end

#teacher=(value) ⇒ Object

Sets the teacher property value. If the primary role is teacher, this block will contain teacher specific data.

Parameters:

  • value

    Value to set for the teacher property.

Returns:

  • a void



740
741
742
# File 'lib/models/education_user.rb', line 740

def teacher=(value)
    @teacher = value
end

#usage_locationObject

Gets the usageLocation property value. A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: US, JP, and GB. Not nullable. Supports $filter.

Returns:

  • a string



747
748
749
# File 'lib/models/education_user.rb', line 747

def usage_location
    return @usage_location
end

#usage_location=(value) ⇒ Object

Sets the usageLocation property value. A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: US, JP, and GB. Not nullable. Supports $filter.

Parameters:

  • value

    Value to set for the usageLocation property.

Returns:

  • a void



755
756
757
# File 'lib/models/education_user.rb', line 755

def usage_location=(value)
    @usage_location = value
end

#userObject

Gets the user property value. The directory user that corresponds to this user.

Returns:

  • a user



762
763
764
# File 'lib/models/education_user.rb', line 762

def user
    return @user
end

#user=(value) ⇒ Object

Sets the user property value. The directory user that corresponds to this user.

Parameters:

  • value

    Value to set for the user property.

Returns:

  • a void



770
771
772
# File 'lib/models/education_user.rb', line 770

def user=(value)
    @user = value
end

#user_principal_nameObject

Gets the userPrincipalName property value. The user principal name (UPN) of the user. The UPN is an internet-style login name for the user based on the internet standard RFC 822. By convention, this should map to the user’s email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of the organization. Supports $filter and $orderby.

Returns:

  • a string



777
778
779
# File 'lib/models/education_user.rb', line 777

def user_principal_name
    return @user_principal_name
end

#user_principal_name=(value) ⇒ Object

Sets the userPrincipalName property value. The user principal name (UPN) of the user. The UPN is an internet-style login name for the user based on the internet standard RFC 822. By convention, this should map to the user’s email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of the organization. Supports $filter and $orderby.

Parameters:

  • value

    Value to set for the userPrincipalName property.

Returns:

  • a void



785
786
787
# File 'lib/models/education_user.rb', line 785

def user_principal_name=(value)
    @user_principal_name = value
end

#user_typeObject

Gets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter.

Returns:

  • a string



792
793
794
# File 'lib/models/education_user.rb', line 792

def user_type
    return @user_type
end

#user_type=(value) ⇒ Object

Sets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter.

Parameters:

  • value

    Value to set for the userType property.

Returns:

  • a void



800
801
802
# File 'lib/models/education_user.rb', line 800

def user_type=(value)
    @user_type = value
end