google_api_tasks v0.10.1 GoogleApi.Tasks.V1.Api.Tasks View Source
API calls for all endpoints tagged Tasks
.
Link to this section Summary
Functions
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.
Deletes the specified task from the task list.
Returns the specified task.
Creates a new task on the specified task list.
Returns all tasks in the specified task list.
Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.
Updates the specified task. This method supports patch semantics.
Updates the specified task.
Link to this section Functions
tasks_tasks_clear(connection, tasklist, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_clear(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
tasks_tasks_delete(connection, tasklist, task, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes the specified task from the task list.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
task
(type:String.t
) - Task identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
tasks_tasks_get(connection, tasklist, task, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Tasks.V1.Model.Task.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns the specified task.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
task
(type:String.t
) - Task identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Task{}}
on success -
{:error, info}
on failure
tasks_tasks_insert(connection, tasklist, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Tasks.V1.Model.Task.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a new task on the specified task list.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:parent
(type:String.t
) - Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional. -
:previous
(type:String.t
) - Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. -
:body
(type:GoogleApi.Tasks.V1.Model.Task.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Task{}}
on success -
{:error, info}
on failure
tasks_tasks_list(connection, tasklist, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Tasks.V1.Model.Tasks.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns all tasks in the specified task list.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:completedMax
(type:String.t
) - Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. -
:completedMin
(type:String.t
) - Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date. -
:dueMax
(type:String.t
) - Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. -
:dueMin
(type:String.t
) - Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date. -
:maxResults
(type:integer()
) - Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100). -
:pageToken
(type:String.t
) - Token specifying the result page to return. Optional. -
:showCompleted
(type:boolean()
) - Flag indicating whether completed tasks are returned in the result. Optional. The default is True. -
:showDeleted
(type:boolean()
) - Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. -
:showHidden
(type:boolean()
) - Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. -
:updatedMin
(type:String.t
) - Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Tasks{}}
on success -
{:error, info}
on failure
tasks_tasks_move(connection, tasklist, task, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_move( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Tasks.V1.Model.Task.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
task
(type:String.t
) - Task identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:parent
(type:String.t
) - New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional. -
:previous
(type:String.t
) - New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Task{}}
on success -
{:error, info}
on failure
tasks_tasks_patch(connection, tasklist, task, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Tasks.V1.Model.Task.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the specified task. This method supports patch semantics.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
task
(type:String.t
) - Task identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Tasks.V1.Model.Task.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Task{}}
on success -
{:error, info}
on failure
tasks_tasks_update(connection, tasklist, task, optional_params \\ [], opts \\ [])
View SourceSpecs
tasks_tasks_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Tasks.V1.Model.Task.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates the specified task.
Parameters
-
connection
(type:GoogleApi.Tasks.V1.Connection.t
) - Connection to server -
tasklist
(type:String.t
) - Task list identifier. -
task
(type:String.t
) - Task identifier. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Tasks.V1.Model.Task.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Tasks.V1.Model.Task{}}
on success -
{:error, info}
on failure