Class: Google::Apis::TasksV1::Task

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/tasks_v1/classes.rb,
lib/google/apis/tasks_v1/representations.rb,
lib/google/apis/tasks_v1/representations.rb

Defined Under Namespace

Classes: Link

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Task

Returns a new instance of Task.



125
126
127
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 125

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#completed ⇒ String

Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. Corresponds to the JSON property completed

Returns:

  • (String) 


33
34
35
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 33

def completed
  @completed
end

#deleted ⇒ Boolean Also known as: deleted?

Flag indicating whether the task has been deleted. The default is False. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 38

def deleted
  @deleted
end

#due ⇒ String

Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API. Corresponds to the JSON property due

Returns:

  • (String) 


47
48
49
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 47

def due
  @due
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


52
53
54
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 52

def etag
  @etag
end

#hidden ⇒ Boolean Also known as: hidden?

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only. Corresponds to the JSON property hidden

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 59

def hidden
  @hidden
end

#id ⇒ String

Task identifier. Corresponds to the JSON property id

Returns:

  • (String) 


65
66
67
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 65

def id
  @id
end

#kind ⇒ String

Output only. Type of the resource. This is always "tasks#task". Corresponds to the JSON property kind

Returns:

  • (String) 


70
71
72
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 70

def kind
  @kind
end

#links ⇒ Array<Google::Apis::TasksV1::Task::Link>

Output only. Collection of links. This collection is read-only. Corresponds to the JSON property links

Returns:



75
76
77
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 75

def links
  @links
end

#notes ⇒ String

Notes describing the task. Optional. Maximum length allowed: 8192 characters. Corresponds to the JSON property notes

Returns:

  • (String) 


80
81
82
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 80

def notes
  @notes
end

#parent ⇒ String

Output only. Parent task identifier. This field is omitted if it is a top- level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. Corresponds to the JSON property parent

Returns:

  • (String) 


87
88
89
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 87

def parent
  @parent
end

#position ⇒ String

Output only. String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). Use the "move" method to move the task to another position. Corresponds to the JSON property position

Returns:

  • (String) 


97
98
99
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 97

def position
  @position
end

#self_link ⇒ String

Output only. URL pointing to this task. Used to retrieve, update, or delete this task. Corresponds to the JSON property selfLink

Returns:

  • (String) 


103
104
105
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 103

def self_link
  @self_link
end

#status ⇒ String

Status of the task. This is either "needsAction" or "completed". Corresponds to the JSON property status

Returns:

  • (String) 


108
109
110
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 108

def status
  @status
end

#title ⇒ String

Title of the task. Maximum length allowed: 1024 characters. Corresponds to the JSON property title

Returns:

  • (String) 


113
114
115
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 113

def title
  @title
end

#updated ⇒ String

Output only. Last modification time of the task (as a RFC 3339 timestamp). Corresponds to the JSON property updated

Returns:

  • (String) 


118
119
120
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 118

def updated
  @updated
end

#web_view_link ⇒ String

Output only. An absolute link to the task in the Google Tasks Web UI. Corresponds to the JSON property webViewLink

Returns:

  • (String) 


123
124
125
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 123

def web_view_link
  @web_view_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/apis/tasks_v1/classes.rb', line 130

def update!(**args)
  @completed = args[:completed] if args.key?(:completed)
  @deleted = args[:deleted] if args.key?(:deleted)
  @due = args[:due] if args.key?(:due)
  @etag = args[:etag] if args.key?(:etag)
  @hidden = args[:hidden] if args.key?(:hidden)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @links = args[:links] if args.key?(:links)
  @notes = args[:notes] if args.key?(:notes)
  @parent = args[:parent] if args.key?(:parent)
  @position = args[:position] if args.key?(:position)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
  @title = args[:title] if args.key?(:title)
  @updated = args[:updated] if args.key?(:updated)
  @web_view_link = args[:web_view_link] if args.key?(:web_view_link)
end