Class: MicrosoftGraph::Models::PlannerTask

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/planner_task.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

#initialize ⇒ Object

Instantiates a new plannerTask and sets the default values.



239
240
241
 
# File 'lib/models/planner_task.rb', line 239

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 planner_task

Raises:

  • (StandardError) 


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

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

Instance Method Details

#active_checklist_item_count ⇒ Object

Gets the activeChecklistItemCount property value. Number of checklist items with value set to false, representing incomplete items.

Returns:

  • a integer



89
90
91
 
# File 'lib/models/planner_task.rb', line 89

def active_checklist_item_count
    return @active_checklist_item_count
end

#active_checklist_item_count=(value) ⇒ Object

Sets the activeChecklistItemCount property value. Number of checklist items with value set to false, representing incomplete items.

Parameters:

  • value —

    Value to set for the activeChecklistItemCount property.

Returns:

  • a void



97
98
99
 
# File 'lib/models/planner_task.rb', line 97

def active_checklist_item_count=(value)
    @active_checklist_item_count = value
end

#applied_categories ⇒ Object

Gets the appliedCategories property value. The categories to which the task has been applied. See applied Categories for possible values.

Returns:

  • a planner_applied_categories



104
105
106
 
# File 'lib/models/planner_task.rb', line 104

def applied_categories
    return @applied_categories
end

#applied_categories=(value) ⇒ Object

Sets the appliedCategories property value. The categories to which the task has been applied. See applied Categories for possible values.

Parameters:

  • value —

    Value to set for the appliedCategories property.

Returns:

  • a void



112
113
114
 
# File 'lib/models/planner_task.rb', line 112

def applied_categories=(value)
    @applied_categories = value
end

#assigned_to_task_board_format ⇒ Object

Gets the assignedToTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Returns:

  • a planner_assigned_to_task_board_task_format



119
120
121
 
# File 'lib/models/planner_task.rb', line 119

def assigned_to_task_board_format
    return @assigned_to_task_board_format
end

#assigned_to_task_board_format=(value) ⇒ Object

Sets the assignedToTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.

Parameters:

  • value —

    Value to set for the assignedToTaskBoardFormat property.

Returns:

  • a void



127
128
129
 
# File 'lib/models/planner_task.rb', line 127

def assigned_to_task_board_format=(value)
    @assigned_to_task_board_format = value
end

#assignee_priority ⇒ Object

Gets the assigneePriority property value. Hint used to order items of this type in a list view. The format is defined as outlined here.

Returns:

  • a string



134
135
136
 
# File 'lib/models/planner_task.rb', line 134

def assignee_priority
    return @assignee_priority
end

#assignee_priority=(value) ⇒ Object

Sets the assigneePriority property value. Hint used to order items of this type in a list view. The format is defined as outlined here.

Parameters:

  • value —

    Value to set for the assigneePriority property.

Returns:

  • a void



142
143
144
 
# File 'lib/models/planner_task.rb', line 142

def assignee_priority=(value)
    @assignee_priority = value
end

#assignments ⇒ Object

Gets the assignments property value. The set of assignees the task is assigned to.

Returns:

  • a planner_assignments



149
150
151
 
# File 'lib/models/planner_task.rb', line 149

def assignments
    return @assignments
end

#assignments=(value) ⇒ Object

Sets the assignments property value. The set of assignees the task is assigned to.

Parameters:

  • value —

    Value to set for the assignments property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/planner_task.rb', line 157

def assignments=(value)
    @assignments = value
end

#bucket_id ⇒ Object

Gets the bucketId property value. Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.

Returns:

  • a string



164
165
166
 
# File 'lib/models/planner_task.rb', line 164

def bucket_id
    return @bucket_id
end

#bucket_id=(value) ⇒ Object

Sets the bucketId property value. Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.

Parameters:

  • value —

    Value to set for the bucketId property.

Returns:

  • a void



172
173
174
 
# File 'lib/models/planner_task.rb', line 172

def bucket_id=(value)
    @bucket_id = value
end

#bucket_task_board_format ⇒ Object

Gets the bucketTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Returns:

  • a planner_bucket_task_board_task_format



179
180
181
 
# File 'lib/models/planner_task.rb', line 179

def bucket_task_board_format
    return @bucket_task_board_format
end

#bucket_task_board_format=(value) ⇒ Object

Sets the bucketTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.

Parameters:

  • value —

    Value to set for the bucketTaskBoardFormat property.

Returns:

  • a void



187
188
189
 
# File 'lib/models/planner_task.rb', line 187

def bucket_task_board_format=(value)
    @bucket_task_board_format = value
end

#checklist_item_count ⇒ Object

Gets the checklistItemCount property value. Number of checklist items that are present on the task.

Returns:

  • a integer



194
195
196
 
# File 'lib/models/planner_task.rb', line 194

def checklist_item_count
    return @checklist_item_count
end

#checklist_item_count=(value) ⇒ Object

Sets the checklistItemCount property value. Number of checklist items that are present on the task.

Parameters:

  • value —

    Value to set for the checklistItemCount property.

Returns:

  • a void



202
203
204
 
# File 'lib/models/planner_task.rb', line 202

def checklist_item_count=(value)
    @checklist_item_count = value
end

#completed_by ⇒ Object

Gets the completedBy property value. Identity of the user that completed the task.

Returns:

  • a identity_set



209
210
211
 
# File 'lib/models/planner_task.rb', line 209

def completed_by
    return @completed_by
end

#completed_by=(value) ⇒ Object

Sets the completedBy property value. Identity of the user that completed the task.

Parameters:

  • value —

    Value to set for the completedBy property.

Returns:

  • a void



217
218
219
 
# File 'lib/models/planner_task.rb', line 217

def completed_by=(value)
    @completed_by = value
end

#completed_date_time ⇒ Object

Gets the completedDateTime property value. Read-only. Date and time at which the ‘percentComplete’ of the task is set to ‘100’. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Returns:

  • a date_time



224
225
226
 
# File 'lib/models/planner_task.rb', line 224

def completed_date_time
    return @completed_date_time
end

#completed_date_time=(value) ⇒ Object

Sets the completedDateTime property value. Read-only. Date and time at which the ‘percentComplete’ of the task is set to ‘100’. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Parameters:

  • value —

    Value to set for the completedDateTime property.

Returns:

  • a void



232
233
234
 
# File 'lib/models/planner_task.rb', line 232

def completed_date_time=(value)
    @completed_date_time = value
end

#conversation_thread_id ⇒ Object

Gets the conversationThreadId property value. Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.

Returns:

  • a string



246
247
248
 
# File 'lib/models/planner_task.rb', line 246

def conversation_thread_id
    return @conversation_thread_id
end

#conversation_thread_id=(value) ⇒ Object

Sets the conversationThreadId property value. Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.

Parameters:

  • value —

    Value to set for the conversationThreadId property.

Returns:

  • a void



254
255
256
 
# File 'lib/models/planner_task.rb', line 254

def conversation_thread_id=(value)
    @conversation_thread_id = value
end

#created_by ⇒ Object

Gets the createdBy property value. Identity of the user that created the task.

Returns:

  • a identity_set



261
262
263
 
# File 'lib/models/planner_task.rb', line 261

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. Identity of the user that created the task.

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



269
270
271
 
# File 'lib/models/planner_task.rb', line 269

def created_by=(value)
    @created_by = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Returns:

  • a date_time



276
277
278
 
# File 'lib/models/planner_task.rb', line 276

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



284
285
286
 
# File 'lib/models/planner_task.rb', line 284

def created_date_time=(value)
    @created_date_time = value
end

#details ⇒ Object

Gets the details property value. Read-only. Nullable. Additional details about the task.

Returns:

  • a planner_task_details



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

def details
    return @details
end

#details=(value) ⇒ Object

Sets the details property value. Read-only. Nullable. Additional details about the task.

Parameters:

  • value —

    Value to set for the details property.

Returns:

  • a void



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

def details=(value)
    @details = value
end

#due_date_time ⇒ Object

Gets the dueDateTime property value. Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Returns:

  • a date_time



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

def due_date_time
    return @due_date_time
end

#due_date_time=(value) ⇒ Object

Sets the dueDateTime property value. Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Parameters:

  • value —

    Value to set for the dueDateTime property.

Returns:

  • a void



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

def due_date_time=(value)
    @due_date_time = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/models/planner_task.rb', line 330

def get_field_deserializers()
    return super.merge({
        "activeChecklistItemCount" => lambda {|n| @active_checklist_item_count = n.get_number_value() },
        "appliedCategories" => lambda {|n| @applied_categories = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerAppliedCategories.create_from_discriminator_value(pn) }) },
        "assignedToTaskBoardFormat" => lambda {|n| @assigned_to_task_board_format = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerAssignedToTaskBoardTaskFormat.create_from_discriminator_value(pn) }) },
        "assigneePriority" => lambda {|n| @assignee_priority = n.get_string_value() },
        "assignments" => lambda {|n| @assignments = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerAssignments.create_from_discriminator_value(pn) }) },
        "bucketId" => lambda {|n| @bucket_id = n.get_string_value() },
        "bucketTaskBoardFormat" => lambda {|n| @bucket_task_board_format = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerBucketTaskBoardTaskFormat.create_from_discriminator_value(pn) }) },
        "checklistItemCount" => lambda {|n| @checklist_item_count = n.get_number_value() },
        "completedBy" => lambda {|n| @completed_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "completedDateTime" => lambda {|n| @completed_date_time = n.get_date_time_value() },
        "conversationThreadId" => lambda {|n| @conversation_thread_id = n.get_string_value() },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "details" => lambda {|n| @details = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerTaskDetails.create_from_discriminator_value(pn) }) },
        "dueDateTime" => lambda {|n| @due_date_time = n.get_date_time_value() },
        "hasDescription" => lambda {|n| @has_description = n.get_boolean_value() },
        "orderHint" => lambda {|n| @order_hint = n.get_string_value() },
        "percentComplete" => lambda {|n| @percent_complete = n.get_number_value() },
        "planId" => lambda {|n| @plan_id = n.get_string_value() },
        "previewType" => lambda {|n| @preview_type = n.get_enum_value(MicrosoftGraph::Models::PlannerPreviewType) },
        "priority" => lambda {|n| @priority = n.get_number_value() },
        "progressTaskBoardFormat" => lambda {|n| @progress_task_board_format = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PlannerProgressTaskBoardTaskFormat.create_from_discriminator_value(pn) }) },
        "referenceCount" => lambda {|n| @reference_count = n.get_number_value() },
        "startDateTime" => lambda {|n| @start_date_time = n.get_date_time_value() },
        "title" => lambda {|n| @title = n.get_string_value() },
    })
end

#has_description ⇒ Object

Gets the hasDescription property value. Read-only. Value is true if the details object of the task has a non-empty description and false otherwise.

Returns:

  • a boolean



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

def has_description
    return @has_description
end

#has_description=(value) ⇒ Object

Sets the hasDescription property value. Read-only. Value is true if the details object of the task has a non-empty description and false otherwise.

Parameters:

  • value —

    Value to set for the hasDescription property.

Returns:

  • a void



371
372
373
 
# File 'lib/models/planner_task.rb', line 371

def has_description=(value)
    @has_description = value
end

#order_hint ⇒ Object

Gets the orderHint property value. Hint used to order items of this type in a list view. The format is defined as outlined here.

Returns:

  • a string



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

def order_hint
    return @order_hint
end

#order_hint=(value) ⇒ Object

Sets the orderHint property value. Hint used to order items of this type in a list view. The format is defined as outlined here.

Parameters:

  • value —

    Value to set for the orderHint property.

Returns:

  • a void



386
387
388
 
# File 'lib/models/planner_task.rb', line 386

def order_hint=(value)
    @order_hint = value
end

#percent_complete ⇒ Object

Gets the percentComplete property value. Percentage of task completion. When set to 100, the task is considered completed.

Returns:

  • a integer



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

def percent_complete
    return @percent_complete
end

#percent_complete=(value) ⇒ Object

Sets the percentComplete property value. Percentage of task completion. When set to 100, the task is considered completed.

Parameters:

  • value —

    Value to set for the percentComplete property.

Returns:

  • a void



401
402
403
 
# File 'lib/models/planner_task.rb', line 401

def percent_complete=(value)
    @percent_complete = value
end

#plan_id ⇒ Object

Gets the planId property value. Plan ID to which the task belongs.

Returns:

  • a string



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

def plan_id
    return @plan_id
end

#plan_id=(value) ⇒ Object

Sets the planId property value. Plan ID to which the task belongs.

Parameters:

  • value —

    Value to set for the planId property.

Returns:

  • a void



416
417
418
 
# File 'lib/models/planner_task.rb', line 416

def plan_id=(value)
    @plan_id = value
end

#preview_type ⇒ Object

Gets the previewType property value. This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.

Returns:

  • a planner_preview_type



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

def preview_type
    return @preview_type
end

#preview_type=(value) ⇒ Object

Sets the previewType property value. This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.

Parameters:

  • value —

    Value to set for the previewType property.

Returns:

  • a void



431
432
433
 
# File 'lib/models/planner_task.rb', line 431

def preview_type=(value)
    @preview_type = value
end

#priority ⇒ Object

Gets the priority property value. Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ‘urgent’, 2, 3 and 4 as ‘important’, 5, 6, and 7 as ‘medium’, and 8, 9, and 10 as ‘low’. Additionally, Planner sets the value 1 for ‘urgent’, 3 for ‘important’, 5 for ‘medium’, and 9 for ‘low’.

Returns:

  • a integer



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

def priority
    return @priority
end

#priority=(value) ⇒ Object

Sets the priority property value. Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ‘urgent’, 2, 3 and 4 as ‘important’, 5, 6, and 7 as ‘medium’, and 8, 9, and 10 as ‘low’. Additionally, Planner sets the value 1 for ‘urgent’, 3 for ‘important’, 5 for ‘medium’, and 9 for ‘low’.

Parameters:

  • value —

    Value to set for the priority property.

Returns:

  • a void



446
447
448
 
# File 'lib/models/planner_task.rb', line 446

def priority=(value)
    @priority = value
end

#progress_task_board_format ⇒ Object

Gets the progressTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Returns:

  • a planner_progress_task_board_task_format



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

def progress_task_board_format
    return @progress_task_board_format
end

#progress_task_board_format=(value) ⇒ Object

Sets the progressTaskBoardFormat property value. Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.

Parameters:

  • value —

    Value to set for the progressTaskBoardFormat property.

Returns:

  • a void



461
462
463
 
# File 'lib/models/planner_task.rb', line 461

def progress_task_board_format=(value)
    @progress_task_board_format = value
end

#reference_count ⇒ Object

Gets the referenceCount property value. Number of external references that exist on the task.

Returns:

  • a integer



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

def reference_count
    return @reference_count
end

#reference_count=(value) ⇒ Object

Sets the referenceCount property value. Number of external references that exist on the task.

Parameters:

  • value —

    Value to set for the referenceCount property.

Returns:

  • a void



476
477
478
 
# File 'lib/models/planner_task.rb', line 476

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


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/models/planner_task.rb', line 484

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_number_value("activeChecklistItemCount", @active_checklist_item_count)
    writer.write_object_value("appliedCategories", @applied_categories)
    writer.write_object_value("assignedToTaskBoardFormat", @assigned_to_task_board_format)
    writer.write_string_value("assigneePriority", @assignee_priority)
    writer.write_object_value("assignments", @assignments)
    writer.write_string_value("bucketId", @bucket_id)
    writer.write_object_value("bucketTaskBoardFormat", @bucket_task_board_format)
    writer.write_number_value("checklistItemCount", @checklist_item_count)
    writer.write_object_value("completedBy", @completed_by)
    writer.write_date_time_value("completedDateTime", @completed_date_time)
    writer.write_string_value("conversationThreadId", @conversation_thread_id)
    writer.write_object_value("createdBy", @created_by)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_object_value("details", @details)
    writer.write_date_time_value("dueDateTime", @due_date_time)
    writer.write_boolean_value("hasDescription", @has_description)
    writer.write_string_value("orderHint", @order_hint)
    writer.write_number_value("percentComplete", @percent_complete)
    writer.write_string_value("planId", @plan_id)
    writer.write_enum_value("previewType", @preview_type)
    writer.write_number_value("priority", @priority)
    writer.write_object_value("progressTaskBoardFormat", @progress_task_board_format)
    writer.write_number_value("referenceCount", @reference_count)
    writer.write_date_time_value("startDateTime", @start_date_time)
    writer.write_string_value("title", @title)
end

#start_date_time ⇒ Object

Gets the startDateTime property value. Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Returns:

  • a date_time



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

def start_date_time
    return @start_date_time
end

#start_date_time=(value) ⇒ Object

Sets the startDateTime property value. Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

Parameters:

  • value —

    Value to set for the startDateTime property.

Returns:

  • a void



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

def start_date_time=(value)
    @start_date_time = value
end

#title ⇒ Object

Gets the title property value. Title of the task.

Returns:

  • a string



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

def title
    return @title
end

#title=(value) ⇒ Object

Sets the title property value. Title of the task.

Parameters:

  • value —

    Value to set for the title property.

Returns:

  • a void



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

def title=(value)
    @title = value
end