Class: MicrosoftGraph::Models::TodoTask

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

#initializeObject

Instantiates a new todoTask and sets the default values.



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

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 todo_task

Raises:

  • (StandardError)


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

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

Instance Method Details

#attachment_sessionsObject

Gets the attachmentSessions property value. The attachmentSessions property

Returns:

  • a attachment_session



74
75
76
# File 'lib/models/todo_task.rb', line 74

def attachment_sessions
    return @attachment_sessions
end

#attachment_sessions=(value) ⇒ Object

Sets the attachmentSessions property value. The attachmentSessions property

Parameters:

  • value

    Value to set for the attachmentSessions property.

Returns:

  • a void



82
83
84
# File 'lib/models/todo_task.rb', line 82

def attachment_sessions=(value)
    @attachment_sessions = value
end

#attachmentsObject

Gets the attachments property value. A collection of file attachments for the task.

Returns:

  • a attachment_base



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

def attachments
    return @attachments
end

#attachments=(value) ⇒ Object

Sets the attachments property value. A collection of file attachments for the task.

Parameters:

  • value

    Value to set for the attachments property.

Returns:

  • a void



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

def attachments=(value)
    @attachments = value
end

#bodyObject

Gets the body property value. The task body that typically contains information about the task.

Returns:

  • a item_body



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

def body
    return @body
end

#body=(value) ⇒ Object

Sets the body property value. The task body that typically contains information about the task.

Parameters:

  • value

    Value to set for the body property.

Returns:

  • a void



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

def body=(value)
    @body = value
end

#body_last_modified_date_timeObject

Gets the bodyLastModifiedDateTime property value. The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Returns:

  • a date_time



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

def body_last_modified_date_time
    return @body_last_modified_date_time
end

#body_last_modified_date_time=(value) ⇒ Object

Sets the bodyLastModifiedDateTime property value. The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Parameters:

  • value

    Value to set for the bodyLastModifiedDateTime property.

Returns:

  • a void



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

def body_last_modified_date_time=(value)
    @body_last_modified_date_time = value
end

#categoriesObject

Gets the categories property value. The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.

Returns:

  • a string



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

def categories
    return @categories
end

#categories=(value) ⇒ Object

Sets the categories property value. The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.

Parameters:

  • value

    Value to set for the categories property.

Returns:

  • a void



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

def categories=(value)
    @categories = value
end

#checklist_itemsObject

Gets the checklistItems property value. A collection of checklistItems linked to a task.

Returns:

  • a checklist_item



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

def checklist_items
    return @checklist_items
end

#checklist_items=(value) ⇒ Object

Sets the checklistItems property value. A collection of checklistItems linked to a task.

Parameters:

  • value

    Value to set for the checklistItems property.

Returns:

  • a void



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

def checklist_items=(value)
    @checklist_items = value
end

#completed_date_timeObject

Gets the completedDateTime property value. The date and time in the specified time zone that the task was finished.

Returns:

  • a date_time_time_zone



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

def completed_date_time
    return @completed_date_time
end

#completed_date_time=(value) ⇒ Object

Sets the completedDateTime property value. The date and time in the specified time zone that the task was finished.

Parameters:

  • value

    Value to set for the completedDateTime property.

Returns:

  • a void



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

def completed_date_time=(value)
    @completed_date_time = value
end

#created_date_timeObject

Gets the createdDateTime property value. The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Returns:

  • a date_time



186
187
188
# File 'lib/models/todo_task.rb', line 186

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



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

def created_date_time=(value)
    @created_date_time = value
end

#due_date_timeObject

Gets the dueDateTime property value. The date and time in the specified time zone that the task is to be finished.

Returns:

  • a date_time_time_zone



210
211
212
# File 'lib/models/todo_task.rb', line 210

def due_date_time
    return @due_date_time
end

#due_date_time=(value) ⇒ Object

Sets the dueDateTime property value. The date and time in the specified time zone that the task is to be finished.

Parameters:

  • value

    Value to set for the dueDateTime property.

Returns:

  • a void



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

def due_date_time=(value)
    @due_date_time = value
end

#extensionsObject

Gets the extensions property value. The collection of open extensions defined for the task. Nullable.

Returns:

  • a extension



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

def extensions
    return @extensions
end

#extensions=(value) ⇒ Object

Sets the extensions property value. The collection of open extensions defined for the task. Nullable.

Parameters:

  • value

    Value to set for the extensions property.

Returns:

  • a void



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

def extensions=(value)
    @extensions = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/models/todo_task.rb', line 240

def get_field_deserializers()
    return super.merge({
        "attachmentSessions" => lambda {|n| @attachment_sessions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AttachmentSession.create_from_discriminator_value(pn) }) },
        "attachments" => lambda {|n| @attachments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AttachmentBase.create_from_discriminator_value(pn) }) },
        "body" => lambda {|n| @body = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ItemBody.create_from_discriminator_value(pn) }) },
        "bodyLastModifiedDateTime" => lambda {|n| @body_last_modified_date_time = n.get_date_time_value() },
        "categories" => lambda {|n| @categories = n.get_collection_of_primitive_values(String) },
        "checklistItems" => lambda {|n| @checklist_items = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::ChecklistItem.create_from_discriminator_value(pn) }) },
        "completedDateTime" => lambda {|n| @completed_date_time = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DateTimeTimeZone.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "dueDateTime" => lambda {|n| @due_date_time = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DateTimeTimeZone.create_from_discriminator_value(pn) }) },
        "extensions" => lambda {|n| @extensions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Extension.create_from_discriminator_value(pn) }) },
        "hasAttachments" => lambda {|n| @has_attachments = n.get_boolean_value() },
        "importance" => lambda {|n| @importance = n.get_enum_value(MicrosoftGraph::Models::Importance) },
        "isReminderOn" => lambda {|n| @is_reminder_on = n.get_boolean_value() },
        "lastModifiedDateTime" => lambda {|n| @last_modified_date_time = n.get_date_time_value() },
        "linkedResources" => lambda {|n| @linked_resources = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::LinkedResource.create_from_discriminator_value(pn) }) },
        "recurrence" => lambda {|n| @recurrence = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PatternedRecurrence.create_from_discriminator_value(pn) }) },
        "reminderDateTime" => lambda {|n| @reminder_date_time = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DateTimeTimeZone.create_from_discriminator_value(pn) }) },
        "startDateTime" => lambda {|n| @start_date_time = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DateTimeTimeZone.create_from_discriminator_value(pn) }) },
        "status" => lambda {|n| @status = n.get_enum_value(MicrosoftGraph::Models::TaskStatus) },
        "title" => lambda {|n| @title = n.get_string_value() },
    })
end

#has_attachmentsObject

Gets the hasAttachments property value. Indicates whether the task has attachments.

Returns:

  • a boolean



268
269
270
# File 'lib/models/todo_task.rb', line 268

def has_attachments
    return @has_attachments
end

#has_attachments=(value) ⇒ Object

Sets the hasAttachments property value. Indicates whether the task has attachments.

Parameters:

  • value

    Value to set for the hasAttachments property.

Returns:

  • a void



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

def has_attachments=(value)
    @has_attachments = value
end

#importanceObject

Gets the importance property value. The importance property

Returns:

  • a importance



283
284
285
# File 'lib/models/todo_task.rb', line 283

def importance
    return @importance
end

#importance=(value) ⇒ Object

Sets the importance property value. The importance property

Parameters:

  • value

    Value to set for the importance property.

Returns:

  • a void



291
292
293
# File 'lib/models/todo_task.rb', line 291

def importance=(value)
    @importance = value
end

#is_reminder_onObject

Gets the isReminderOn property value. Set to true if an alert is set to remind the user of the task.

Returns:

  • a boolean



298
299
300
# File 'lib/models/todo_task.rb', line 298

def is_reminder_on
    return @is_reminder_on
end

#is_reminder_on=(value) ⇒ Object

Sets the isReminderOn property value. Set to true if an alert is set to remind the user of the task.

Parameters:

  • value

    Value to set for the isReminderOn property.

Returns:

  • a void



306
307
308
# File 'lib/models/todo_task.rb', line 306

def is_reminder_on=(value)
    @is_reminder_on = value
end

#last_modified_date_timeObject

Gets the lastModifiedDateTime property value. The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Returns:

  • a date_time



313
314
315
# File 'lib/models/todo_task.rb', line 313

def last_modified_date_time
    return @last_modified_date_time
end

#last_modified_date_time=(value) ⇒ Object

Sets the lastModifiedDateTime property value. The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.

Parameters:

  • value

    Value to set for the lastModifiedDateTime property.

Returns:

  • a void



321
322
323
# File 'lib/models/todo_task.rb', line 321

def last_modified_date_time=(value)
    @last_modified_date_time = value
end

#linked_resourcesObject

Gets the linkedResources property value. A collection of resources linked to the task.

Returns:

  • a linked_resource



328
329
330
# File 'lib/models/todo_task.rb', line 328

def linked_resources
    return @linked_resources
end

#linked_resources=(value) ⇒ Object

Sets the linkedResources property value. A collection of resources linked to the task.

Parameters:

  • value

    Value to set for the linkedResources property.

Returns:

  • a void



336
337
338
# File 'lib/models/todo_task.rb', line 336

def linked_resources=(value)
    @linked_resources = value
end

#recurrenceObject

Gets the recurrence property value. The recurrence pattern for the task.

Returns:

  • a patterned_recurrence



343
344
345
# File 'lib/models/todo_task.rb', line 343

def recurrence
    return @recurrence
end

#recurrence=(value) ⇒ Object

Sets the recurrence property value. The recurrence pattern for the task.

Parameters:

  • value

    Value to set for the recurrence property.

Returns:

  • a void



351
352
353
# File 'lib/models/todo_task.rb', line 351

def recurrence=(value)
    @recurrence = value
end

#reminder_date_timeObject

Gets the reminderDateTime property value. The date and time in the specified time zone for a reminder alert of the task to occur.

Returns:

  • a date_time_time_zone



358
359
360
# File 'lib/models/todo_task.rb', line 358

def reminder_date_time
    return @reminder_date_time
end

#reminder_date_time=(value) ⇒ Object

Sets the reminderDateTime property value. The date and time in the specified time zone for a reminder alert of the task to occur.

Parameters:

  • value

    Value to set for the reminderDateTime property.

Returns:

  • a void



366
367
368
# File 'lib/models/todo_task.rb', line 366

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


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/models/todo_task.rb', line 374

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("attachmentSessions", @attachment_sessions)
    writer.write_collection_of_object_values("attachments", @attachments)
    writer.write_object_value("body", @body)
    writer.write_date_time_value("bodyLastModifiedDateTime", @body_last_modified_date_time)
    writer.write_collection_of_primitive_values("categories", @categories)
    writer.write_collection_of_object_values("checklistItems", @checklist_items)
    writer.write_object_value("completedDateTime", @completed_date_time)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_object_value("dueDateTime", @due_date_time)
    writer.write_collection_of_object_values("extensions", @extensions)
    writer.write_boolean_value("hasAttachments", @has_attachments)
    writer.write_enum_value("importance", @importance)
    writer.write_boolean_value("isReminderOn", @is_reminder_on)
    writer.write_date_time_value("lastModifiedDateTime", @last_modified_date_time)
    writer.write_collection_of_object_values("linkedResources", @linked_resources)
    writer.write_object_value("recurrence", @recurrence)
    writer.write_object_value("reminderDateTime", @reminder_date_time)
    writer.write_object_value("startDateTime", @start_date_time)
    writer.write_enum_value("status", @status)
    writer.write_string_value("title", @title)
end

#start_date_timeObject

Gets the startDateTime property value. The date and time in the specified time zone at which the task is scheduled to start.

Returns:

  • a date_time_time_zone



402
403
404
# File 'lib/models/todo_task.rb', line 402

def start_date_time
    return @start_date_time
end

#start_date_time=(value) ⇒ Object

Sets the startDateTime property value. The date and time in the specified time zone at which the task is scheduled to start.

Parameters:

  • value

    Value to set for the startDateTime property.

Returns:

  • a void



410
411
412
# File 'lib/models/todo_task.rb', line 410

def start_date_time=(value)
    @start_date_time = value
end

#statusObject

Gets the status property value. The status property

Returns:

  • a task_status



417
418
419
# File 'lib/models/todo_task.rb', line 417

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. The status property

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



425
426
427
# File 'lib/models/todo_task.rb', line 425

def status=(value)
    @status = value
end

#titleObject

Gets the title property value. A brief description of the task.

Returns:

  • a string



432
433
434
# File 'lib/models/todo_task.rb', line 432

def title
    return @title
end

#title=(value) ⇒ Object

Sets the title property value. A brief description of the task.

Parameters:

  • value

    Value to set for the title property.

Returns:

  • a void



440
441
442
# File 'lib/models/todo_task.rb', line 440

def title=(value)
    @title = value
end