package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val clear : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> tasklist:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

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.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter tasklist

    Task list identifier.

val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> tasklist:string -> task:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes the specified task from the task list.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter tasklist

    Task list identifier.

  • parameter task

    Task identifier.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> tasklist:string -> task:string -> GapiConversation.Session.t -> GapiTasksV1Model.Task.t * GapiConversation.Session.t

Returns the specified task.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter etag

    Optional ETag.

  • parameter std_params

    Optional standard parameters.

  • parameter tasklist

    Task list identifier.

  • parameter task

    Task identifier.

val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?parent:string -> ?previous:string -> tasklist:string -> GapiTasksV1Model.Task.t -> GapiConversation.Session.t -> GapiTasksV1Model.Task.t * GapiConversation.Session.t

Creates a new task on the specified task list.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter parent

    Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.

  • parameter previous

    Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.

  • parameter tasklist

    Task list identifier.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?completedMax:string -> ?completedMin:string -> ?dueMax:string -> ?dueMin:string -> ?maxResults:int64 -> ?pageToken:string -> ?showCompleted:bool -> ?showDeleted:bool -> ?showHidden:bool -> ?updatedMin:string -> tasklist:string -> GapiConversation.Session.t -> GapiTasksV1Model.Tasks.t * GapiConversation.Session.t

Returns all tasks in the specified task list.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter completedMax

    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.

  • parameter completedMin

    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.

  • parameter dueMax

    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.

  • parameter dueMin

    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.

  • parameter maxResults

    Maximum number of task lists returned on one page. Optional. The default is 100.

  • parameter pageToken

    Token specifying the result page to return. Optional.

  • parameter showCompleted

    Flag indicating whether completed tasks are returned in the result. Optional. The default is True.

  • parameter showDeleted

    Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.

  • parameter showHidden

    Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.

  • parameter updatedMin

    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.

  • parameter tasklist

    Task list identifier.

val move : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?parent:string -> ?previous:string -> tasklist:string -> task:string -> GapiConversation.Session.t -> GapiTasksV1Model.Task.t * GapiConversation.Session.t

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.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter parent

    New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.

  • parameter previous

    New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.

  • parameter tasklist

    Task list identifier.

  • parameter task

    Task identifier.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> tasklist:string -> task:string -> GapiTasksV1Model.Task.t -> GapiConversation.Session.t -> GapiTasksV1Model.Task.t * GapiConversation.Session.t

Updates the specified task. This method supports patch semantics.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter tasklist

    Task list identifier.

  • parameter task

    Task identifier.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> tasklist:string -> task:string -> GapiTasksV1Model.Task.t -> GapiConversation.Session.t -> GapiTasksV1Model.Task.t * GapiConversation.Session.t

Updates the specified task.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/tasks/v1/").

  • parameter std_params

    Optional standard parameters.

  • parameter tasklist

    Task list identifier.

  • parameter task

    Task identifier.