google_api_tasks v0.2.0 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

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

Link to this section Functions

Link to this function

tasks_tasks_clear(connection, tasklist, optional_params \\ [], opts \\ []) View Source

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 (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

tasks_tasks_delete(connection, tasklist, task, optional_params \\ [], opts \\ []) View Source

Deletes the specified task from the task list.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • task (String.t): Task identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

tasks_tasks_get(connection, tasklist, task, optional_params \\ [], opts \\ []) View Source

Returns the specified task.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • task (String.t): Task identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Task{}} on success {:error, info} on failure

Link to this function

tasks_tasks_insert(connection, tasklist, optional_params \\ [], opts \\ []) View Source

Creates a new task on the specified task list.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :parent (String.t): Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
    • :previous (String.t): Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
    • :body (Task):

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Task{}} on success {:error, info} on failure

Link to this function

tasks_tasks_list(connection, tasklist, optional_params \\ [], opts \\ []) View Source

Returns all tasks in the specified task list.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :completedMax (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 (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 (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 (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 (String.t): Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
    • :pageToken (String.t): Token specifying the result page to return. Optional.
    • :showCompleted (boolean()): Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
    • :showDeleted (boolean()): Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
    • :showHidden (boolean()): Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
    • :updatedMin (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.

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Tasks{}} on success {:error, info} on failure

Link to this function

tasks_tasks_move(connection, tasklist, task, optional_params \\ [], opts \\ []) View Source

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 (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • task (String.t): Task identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :parent (String.t): New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
    • :previous (String.t): New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Task{}} on success {:error, info} on failure

Link to this function

tasks_tasks_patch(connection, tasklist, task, optional_params \\ [], opts \\ []) View Source

Updates the specified task. This method supports patch semantics.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • task (String.t): Task identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Task):

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Task{}} on success {:error, info} on failure

Link to this function

tasks_tasks_update(connection, tasklist, task, optional_params \\ [], opts \\ []) View Source

Updates the specified task.

Parameters

  • connection (GoogleApi.Tasks.V1.Connection): Connection to server
  • tasklist (String.t): Task list identifier.
  • task (String.t): Task identifier.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (Task):

Returns

{:ok, %GoogleApi.Tasks.V1.Model.Task{}} on success {:error, info} on failure