Class: MicrosoftGraph::Models::Team

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/team.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 team and sets the default values.



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

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 team

Raises:

  • (StandardError)


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

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

Instance Method Details

#all_channelsObject

Gets the allChannels property value. List of channels either hosted in or shared with the team (incoming channels).

Returns:

  • a channel



98
99
100
# File 'lib/models/team.rb', line 98

def all_channels
    return @all_channels
end

#all_channels=(value) ⇒ Object

Sets the allChannels property value. List of channels either hosted in or shared with the team (incoming channels).

Parameters:

  • value

    Value to set for the allChannels property.

Returns:

  • a void



106
107
108
# File 'lib/models/team.rb', line 106

def all_channels=(value)
    @all_channels = value
end

#channelsObject

Gets the channels property value. The collection of channels and messages associated with the team.

Returns:

  • a channel



113
114
115
# File 'lib/models/team.rb', line 113

def channels
    return @channels
end

#channels=(value) ⇒ Object

Sets the channels property value. The collection of channels and messages associated with the team.

Parameters:

  • value

    Value to set for the channels property.

Returns:

  • a void



121
122
123
# File 'lib/models/team.rb', line 121

def channels=(value)
    @channels = value
end

#classificationObject

Gets the classification property value. An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant’s directory.

Returns:

  • a string



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

def classification
    return @classification
end

#classification=(value) ⇒ Object

Sets the classification property value. An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant’s directory.

Parameters:

  • value

    Value to set for the classification property.

Returns:

  • a void



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

def classification=(value)
    @classification = value
end

#created_date_timeObject

Gets the createdDateTime property value. Timestamp at which the team was created.

Returns:

  • a date_time



150
151
152
# File 'lib/models/team.rb', line 150

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Timestamp at which the team was created.

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



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

def created_date_time=(value)
    @created_date_time = value
end

#descriptionObject

Gets the description property value. An optional description for the team. Maximum length: 1024 characters.

Returns:

  • a string



174
175
176
# File 'lib/models/team.rb', line 174

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. An optional description for the team. Maximum length: 1024 characters.

Parameters:

  • value

    Value to set for the description property.

Returns:

  • a void



182
183
184
# File 'lib/models/team.rb', line 182

def description=(value)
    @description = value
end

#display_nameObject

Gets the displayName property value. The name of the team.

Returns:

  • a string



189
190
191
# File 'lib/models/team.rb', line 189

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The name of the team.

Parameters:

  • value

    Value to set for the displayName property.

Returns:

  • a void



197
198
199
# File 'lib/models/team.rb', line 197

def display_name=(value)
    @display_name = value
end

#fun_settingsObject

Gets the funSettings property value. Settings to configure use of Giphy, memes, and stickers in the team.

Returns:

  • a team_fun_settings



204
205
206
# File 'lib/models/team.rb', line 204

def fun_settings
    return @fun_settings
end

#fun_settings=(value) ⇒ Object

Sets the funSettings property value. Settings to configure use of Giphy, memes, and stickers in the team.

Parameters:

  • value

    Value to set for the funSettings property.

Returns:

  • a void



212
213
214
# File 'lib/models/team.rb', line 212

def fun_settings=(value)
    @fun_settings = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/models/team.rb', line 219

def get_field_deserializers()
    return super.merge({
        "allChannels" => lambda {|n| @all_channels = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Channel.create_from_discriminator_value(pn) }) },
        "channels" => lambda {|n| @channels = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Channel.create_from_discriminator_value(pn) }) },
        "classification" => lambda {|n| @classification = n.get_string_value() },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "funSettings" => lambda {|n| @fun_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamFunSettings.create_from_discriminator_value(pn) }) },
        "group" => lambda {|n| @group = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Group.create_from_discriminator_value(pn) }) },
        "guestSettings" => lambda {|n| @guest_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamGuestSettings.create_from_discriminator_value(pn) }) },
        "incomingChannels" => lambda {|n| @incoming_channels = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Channel.create_from_discriminator_value(pn) }) },
        "installedApps" => lambda {|n| @installed_apps = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TeamsAppInstallation.create_from_discriminator_value(pn) }) },
        "internalId" => lambda {|n| @internal_id = n.get_string_value() },
        "isArchived" => lambda {|n| @is_archived = n.get_boolean_value() },
        "memberSettings" => lambda {|n| @member_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamMemberSettings.create_from_discriminator_value(pn) }) },
        "members" => lambda {|n| @members = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ConversationMember.create_from_discriminator_value(pn) }) },
        "messagingSettings" => lambda {|n| @messaging_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamMessagingSettings.create_from_discriminator_value(pn) }) },
        "operations" => lambda {|n| @operations = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TeamsAsyncOperation.create_from_discriminator_value(pn) }) },
        "permissionGrants" => lambda {|n| @permission_grants = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ResourceSpecificPermissionGrant.create_from_discriminator_value(pn) }) },
        "photo" => lambda {|n| @photo = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ProfilePhoto.create_from_discriminator_value(pn) }) },
        "primaryChannel" => lambda {|n| @primary_channel = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Channel.create_from_discriminator_value(pn) }) },
        "schedule" => lambda {|n| @schedule = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Schedule.create_from_discriminator_value(pn) }) },
        "specialization" => lambda {|n| @specialization = n.get_enum_value(MicrosoftGraph::Models::TeamSpecialization) },
        "summary" => lambda {|n| @summary = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamSummary.create_from_discriminator_value(pn) }) },
        "tags" => lambda {|n| @tags = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::TeamworkTag.create_from_discriminator_value(pn) }) },
        "template" => lambda {|n| @template = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TeamsTemplate.create_from_discriminator_value(pn) }) },
        "tenantId" => lambda {|n| @tenant_id = n.get_string_value() },
        "visibility" => lambda {|n| @visibility = n.get_enum_value(MicrosoftGraph::Models::TeamVisibilityType) },
        "webUrl" => lambda {|n| @web_url = n.get_string_value() },
    })
end

#groupObject

Gets the group property value. The group property

Returns:

  • a group



255
256
257
# File 'lib/models/team.rb', line 255

def group
    return @group
end

#group=(value) ⇒ Object

Sets the group property value. The group property

Parameters:

  • value

    Value to set for the group property.

Returns:

  • a void



263
264
265
# File 'lib/models/team.rb', line 263

def group=(value)
    @group = value
end

#guest_settingsObject

Gets the guestSettings property value. Settings to configure whether guests can create, update, or delete channels in the team.

Returns:

  • a team_guest_settings



270
271
272
# File 'lib/models/team.rb', line 270

def guest_settings
    return @guest_settings
end

#guest_settings=(value) ⇒ Object

Sets the guestSettings property value. Settings to configure whether guests can create, update, or delete channels in the team.

Parameters:

  • value

    Value to set for the guestSettings property.

Returns:

  • a void



278
279
280
# File 'lib/models/team.rb', line 278

def guest_settings=(value)
    @guest_settings = value
end

#incoming_channelsObject

Gets the incomingChannels property value. List of channels shared with the team.

Returns:

  • a channel



285
286
287
# File 'lib/models/team.rb', line 285

def incoming_channels
    return @incoming_channels
end

#incoming_channels=(value) ⇒ Object

Sets the incomingChannels property value. List of channels shared with the team.

Parameters:

  • value

    Value to set for the incomingChannels property.

Returns:

  • a void



293
294
295
# File 'lib/models/team.rb', line 293

def incoming_channels=(value)
    @incoming_channels = value
end

#installed_appsObject

Gets the installedApps property value. The apps installed in this team.

Returns:

  • a teams_app_installation



300
301
302
# File 'lib/models/team.rb', line 300

def installed_apps
    return @installed_apps
end

#installed_apps=(value) ⇒ Object

Sets the installedApps property value. The apps installed in this team.

Parameters:

  • value

    Value to set for the installedApps property.

Returns:

  • a void



308
309
310
# File 'lib/models/team.rb', line 308

def installed_apps=(value)
    @installed_apps = value
end

#internal_idObject

Gets the internalId property value. A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.

Returns:

  • a string



315
316
317
# File 'lib/models/team.rb', line 315

def internal_id
    return @internal_id
end

#internal_id=(value) ⇒ Object

Sets the internalId property value. A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.

Parameters:

  • value

    Value to set for the internalId property.

Returns:

  • a void



323
324
325
# File 'lib/models/team.rb', line 323

def internal_id=(value)
    @internal_id = value
end

#is_archivedObject

Gets the isArchived property value. Whether this team is in read-only mode.

Returns:

  • a boolean



330
331
332
# File 'lib/models/team.rb', line 330

def is_archived
    return @is_archived
end

#is_archived=(value) ⇒ Object

Sets the isArchived property value. Whether this team is in read-only mode.

Parameters:

  • value

    Value to set for the isArchived property.

Returns:

  • a void



338
339
340
# File 'lib/models/team.rb', line 338

def is_archived=(value)
    @is_archived = value
end

#member_settingsObject

Gets the memberSettings property value. Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.

Returns:

  • a team_member_settings



345
346
347
# File 'lib/models/team.rb', line 345

def member_settings
    return @member_settings
end

#member_settings=(value) ⇒ Object

Sets the memberSettings property value. Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.

Parameters:

  • value

    Value to set for the memberSettings property.

Returns:

  • a void



353
354
355
# File 'lib/models/team.rb', line 353

def member_settings=(value)
    @member_settings = value
end

#membersObject

Gets the members property value. Members and owners of the team.

Returns:

  • a conversation_member



360
361
362
# File 'lib/models/team.rb', line 360

def members
    return @members
end

#members=(value) ⇒ Object

Sets the members property value. Members and owners of the team.

Parameters:

  • value

    Value to set for the members property.

Returns:

  • a void



368
369
370
# File 'lib/models/team.rb', line 368

def members=(value)
    @members = value
end

#messaging_settingsObject

Gets the messagingSettings property value. Settings to configure messaging and mentions in the team.

Returns:

  • a team_messaging_settings



375
376
377
# File 'lib/models/team.rb', line 375

def messaging_settings
    return @messaging_settings
end

#messaging_settings=(value) ⇒ Object

Sets the messagingSettings property value. Settings to configure messaging and mentions in the team.

Parameters:

  • value

    Value to set for the messagingSettings property.

Returns:

  • a void



383
384
385
# File 'lib/models/team.rb', line 383

def messaging_settings=(value)
    @messaging_settings = value
end

#operationsObject

Gets the operations property value. The async operations that ran or are running on this team.

Returns:

  • a teams_async_operation



390
391
392
# File 'lib/models/team.rb', line 390

def operations
    return @operations
end

#operations=(value) ⇒ Object

Sets the operations property value. The async operations that ran or are running on this team.

Parameters:

  • value

    Value to set for the operations property.

Returns:

  • a void



398
399
400
# File 'lib/models/team.rb', line 398

def operations=(value)
    @operations = value
end

#permission_grantsObject

Gets the permissionGrants property value. The permissionGrants property

Returns:

  • a resource_specific_permission_grant



405
406
407
# File 'lib/models/team.rb', line 405

def permission_grants
    return @permission_grants
end

#permission_grants=(value) ⇒ Object

Sets the permissionGrants property value. The permissionGrants property

Parameters:

  • value

    Value to set for the permissionGrants property.

Returns:

  • a void



413
414
415
# File 'lib/models/team.rb', line 413

def permission_grants=(value)
    @permission_grants = value
end

#photoObject

Gets the photo property value. The profile photo for the team.

Returns:

  • a profile_photo



420
421
422
# File 'lib/models/team.rb', line 420

def photo
    return @photo
end

#photo=(value) ⇒ Object

Sets the photo property value. The profile photo for the team.

Parameters:

  • value

    Value to set for the photo property.

Returns:

  • a void



428
429
430
# File 'lib/models/team.rb', line 428

def photo=(value)
    @photo = value
end

#primary_channelObject

Gets the primaryChannel property value. The general channel for the team.

Returns:

  • a channel



435
436
437
# File 'lib/models/team.rb', line 435

def primary_channel
    return @primary_channel
end

#primary_channel=(value) ⇒ Object

Sets the primaryChannel property value. The general channel for the team.

Parameters:

  • value

    Value to set for the primaryChannel property.

Returns:

  • a void



443
444
445
# File 'lib/models/team.rb', line 443

def primary_channel=(value)
    @primary_channel = value
end

#scheduleObject

Gets the schedule property value. The schedule of shifts for this team.

Returns:

  • a schedule



450
451
452
# File 'lib/models/team.rb', line 450

def schedule
    return @schedule
end

#schedule=(value) ⇒ Object

Sets the schedule property value. The schedule of shifts for this team.

Parameters:

  • value

    Value to set for the schedule property.

Returns:

  • a void



458
459
460
# File 'lib/models/team.rb', line 458

def schedule=(value)
    @schedule = 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)


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
# File 'lib/models/team.rb', line 466

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("allChannels", @all_channels)
    writer.write_collection_of_object_values("channels", @channels)
    writer.write_string_value("classification", @classification)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_object_value("funSettings", @fun_settings)
    writer.write_object_value("group", @group)
    writer.write_object_value("guestSettings", @guest_settings)
    writer.write_collection_of_object_values("incomingChannels", @incoming_channels)
    writer.write_collection_of_object_values("installedApps", @installed_apps)
    writer.write_string_value("internalId", @internal_id)
    writer.write_boolean_value("isArchived", @is_archived)
    writer.write_object_value("memberSettings", @member_settings)
    writer.write_collection_of_object_values("members", @members)
    writer.write_object_value("messagingSettings", @messaging_settings)
    writer.write_collection_of_object_values("operations", @operations)
    writer.write_collection_of_object_values("permissionGrants", @permission_grants)
    writer.write_object_value("photo", @photo)
    writer.write_object_value("primaryChannel", @primary_channel)
    writer.write_object_value("schedule", @schedule)
    writer.write_enum_value("specialization", @specialization)
    writer.write_object_value("summary", @summary)
    writer.write_collection_of_object_values("tags", @tags)
    writer.write_object_value("template", @template)
    writer.write_string_value("tenantId", @tenant_id)
    writer.write_enum_value("visibility", @visibility)
    writer.write_string_value("webUrl", @web_url)
end

#specializationObject

Gets the specialization property value. Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.

Returns:

  • a team_specialization



502
503
504
# File 'lib/models/team.rb', line 502

def specialization
    return @specialization
end

#specialization=(value) ⇒ Object

Sets the specialization property value. Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.

Parameters:

  • value

    Value to set for the specialization property.

Returns:

  • a void



510
511
512
# File 'lib/models/team.rb', line 510

def specialization=(value)
    @specialization = value
end

#summaryObject

Gets the summary property value. Contains summary information about the team, including number of owners, members, and guests.

Returns:

  • a team_summary



517
518
519
# File 'lib/models/team.rb', line 517

def summary
    return @summary
end

#summary=(value) ⇒ Object

Sets the summary property value. Contains summary information about the team, including number of owners, members, and guests.

Parameters:

  • value

    Value to set for the summary property.

Returns:

  • a void



525
526
527
# File 'lib/models/team.rb', line 525

def summary=(value)
    @summary = value
end

#tagsObject

Gets the tags property value. The tags associated with the team.

Returns:

  • a teamwork_tag



532
533
534
# File 'lib/models/team.rb', line 532

def tags
    return @tags
end

#tags=(value) ⇒ Object

Sets the tags property value. The tags associated with the team.

Parameters:

  • value

    Value to set for the tags property.

Returns:

  • a void



540
541
542
# File 'lib/models/team.rb', line 540

def tags=(value)
    @tags = value
end

#templateObject

Gets the template property value. The template this team was created from. See available templates.

Returns:

  • a teams_template



547
548
549
# File 'lib/models/team.rb', line 547

def template
    return @template
end

#template=(value) ⇒ Object

Sets the template property value. The template this team was created from. See available templates.

Parameters:

  • value

    Value to set for the template property.

Returns:

  • a void



555
556
557
# File 'lib/models/team.rb', line 555

def template=(value)
    @template = value
end

#tenant_idObject

Gets the tenantId property value. The ID of the Azure Active Directory tenant.

Returns:

  • a string



562
563
564
# File 'lib/models/team.rb', line 562

def tenant_id
    return @tenant_id
end

#tenant_id=(value) ⇒ Object

Sets the tenantId property value. The ID of the Azure Active Directory tenant.

Parameters:

  • value

    Value to set for the tenantId property.

Returns:

  • a void



570
571
572
# File 'lib/models/team.rb', line 570

def tenant_id=(value)
    @tenant_id = value
end

#visibilityObject

Gets the visibility property value. The visibility of the group and team. Defaults to Public.

Returns:

  • a team_visibility_type



577
578
579
# File 'lib/models/team.rb', line 577

def visibility
    return @visibility
end

#visibility=(value) ⇒ Object

Sets the visibility property value. The visibility of the group and team. Defaults to Public.

Parameters:

  • value

    Value to set for the visibility property.

Returns:

  • a void



585
586
587
# File 'lib/models/team.rb', line 585

def visibility=(value)
    @visibility = value
end

#web_urlObject

Gets the webUrl property value. A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.

Returns:

  • a string



592
593
594
# File 'lib/models/team.rb', line 592

def web_url
    return @web_url
end

#web_url=(value) ⇒ Object

Sets the webUrl property value. A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.

Parameters:

  • value

    Value to set for the webUrl property.

Returns:

  • a void



600
601
602
# File 'lib/models/team.rb', line 600

def web_url=(value)
    @web_url = value
end