Documentation
¶
Index ¶
Constants ¶
View Source
const CTJSON string = "application/json"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PageMetadata ¶
type SDK ¶
type SDK interface {
// CreateTask creates a new task.
//
// example:
// task := sdk.Task{
// Name: "John Doe"
// }
// task, _ := sdk.CreateTask(task)
// fmt.Println(task)
CreateTask(task Task) (Task, error)
// GetTask gets a task by id.
//
// example:
// task, _ := sdk.GetTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
GetTask(id string) (Task, error)
// ListTasks lists tasks.
//
// example:
// taskPage, _ := sdk.ListTasks(0, 10)
// fmt.Println(taskPage)
ListTasks(offset uint64, limit uint64) (TaskPage, error)
// UpdateTask updates a task.
//
// example:
// task := sdk.Task{
// Name: "John Doe"
// }
// task, _ := sdk.UpdateTask(task)
// fmt.Println(task)
UpdateTask(task Task) (Task, error)
// DeleteTask deletes a task.
//
// example:
// task, _ := sdk.DeleteTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
DeleteTask(id string) error
// StartTask starts a task.
//
// example:
// task, _ := sdk.StartTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
StartTask(id string) error
// StopTask stops a task.
//
// example:
// task, _ := sdk.StopTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
StopTask(id string) error
}
Click to show internal directories.
Click to hide internal directories.