note

package
v1.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateNote 

func CreateNote(ac *client.AlpaconClient, noteRequest NoteCreateRequest) error

func DeleteNote 

func DeleteNote(ac *client.AlpaconClient, noteID string) error

func GetNoteDetail added in v1.2.0 

func GetNoteDetail(ac *client.AlpaconClient, noteID string) ([]byte, error)

func UpdateNote added in v1.2.0 

func UpdateNote(ac *client.AlpaconClient, noteID string) ([]byte, error)

Types

type NoteCreateRequest 

type NoteCreateRequest struct {
	Server  string `json:"server"`
	Content string `json:"content"`
	Private bool   `json:"private"`
	Pinned  bool   `json:"pinned"`
}

type NoteDetails 

type NoteDetails struct {
	ID      string `json:"id"`
	Server  string `json:"server"`
	Author  string `json:"author"`
	Content string `json:"content"`
	Private bool   `json:"private"`
}

NoteDetails is the display type for PrintTable.

func GetNoteList 

func GetNoteList(ac *client.AlpaconClient, serverName string, pageSize int) ([]NoteDetails, error)

type NoteResponse added in v1.2.0 

type NoteResponse struct {
	ID      string              `json:"id"`
	Server  types.ServerSummary `json:"server"`
	Author  types.UserSummary   `json:"author"`
	Content string              `json:"content"`
	Private bool                `json:"private"`
}

NoteResponse is the API response type where Server and Author are nested objects.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.