clips

Documentation

Index

• Constants
• type CreateRequest
  • func (r CreateRequest) Validate() error
• type ListRequest
  • func (r ListRequest) Validate() error
• type Service
  • func NewService(requestHandler core.RequestHandlerFunc) *Service
  • func (s *Service) Create(request CreateRequest) (models.Clip, error)
  • func (s *Service) List() ([]models.Clip, error)
  • func (s *Service) Show(request ShowRequest) (models.Clip, error)
  • func (s *Service) Update(request UpdateRequest) (models.Clip, error)
• type ShowRequest
  • func (r ShowRequest) Validate() error
• type UpdateRequest
  • func (r UpdateRequest) Validate() error

Examples

• Service.Create
• Service.List
• Service.Show
• Service.Update

Constants

const (
	// MaximumNameLength is the maximum length of the name of the clip.
	MaximumNameLength = 100
)

Types

type CreateRequest

type CreateRequest struct {
	Name string `json:"name"`
}

CreateRequest represents a Create request.

func (CreateRequest) Validate

func (r CreateRequest) Validate() error

Validate request.

type ListRequest

type ListRequest struct{}

ListRequest represents an List request.

func (ListRequest) Validate

func (r ListRequest) Validate() error

Validate the request.

type Service

type Service struct {
	Call core.RequestHandlerFunc
}

Service is the base for all the endpoints on this service.

func NewService

func NewService(requestHandler core.RequestHandlerFunc) *Service

NewService creates a new Service instance.

func (*Service) Create

func (s *Service) Create(request CreateRequest) (models.Clip, error)

Create clip.

Example

client, _ := misskey.NewClientWithOptions(misskey.WithSimpleConfig("https://slippy.xyz", os.Getenv("MISSKEY_TOKEN")))

clip, err := client.Clips().Create(clips.CreateRequest{
	Name: "test clip",
})
if err != nil {
	log.Printf("[Clips/Create] %s", err)

	return
}

log.Printf("[Clips/Create] %s created", clip.Name)

func (*Service) List

func (s *Service) List() ([]models.Clip, error)

List clips.

Example

client, _ := misskey.NewClientWithOptions(misskey.WithSimpleConfig("https://slippy.xyz", os.Getenv("MISSKEY_TOKEN")))

clips, err := client.Clips().List()
if err != nil {
	log.Printf("[Clips/List] %s", err)

	return
}

for _, clip := range clips {
	log.Printf("[Clips/List] %s", clip.Name)
}

func (*Service) Show

func (s *Service) Show(request ShowRequest) (models.Clip, error)

Show clips.

Example

client, _ := misskey.NewClientWithOptions(misskey.WithSimpleConfig("https://slippy.xyz", os.Getenv("MISSKEY_TOKEN")))

clip, err := client.Clips().Show(clips.ShowRequest{
	ClipID: "8drxu3ckca",
})
if err != nil {
	log.Printf("[Clips/Show] %s", err)

	return
}

log.Printf("[Clips/Show] %s", clip.Name)

func (*Service) Update

func (s *Service) Update(request UpdateRequest) (models.Clip, error)

Update clip.

Example

client, _ := misskey.NewClientWithOptions(misskey.WithSimpleConfig("https://slippy.xyz", os.Getenv("MISSKEY_TOKEN")))

clip, err := client.Clips().Update(clips.UpdateRequest{
	ClipID: "8drxu3ckca",
	Name:   "new test",
})
if err != nil {
	log.Printf("[Clips/Update] %s", err)

	return
}

log.Printf("[Clips/Update] %s updated", clip.Name)

type ShowRequest

type ShowRequest struct {
	ClipID string `json:"clipId"`
}

ShowRequest represents an Show request.

func (ShowRequest) Validate

func (r ShowRequest) Validate() error

Validate the request.

type UpdateRequest

type UpdateRequest struct {
	ClipID string `json:"clipId"`
	Name   string `json:"name"`
}

UpdateRequest represents a Update request.

func (UpdateRequest) Validate

func (r UpdateRequest) Validate() error

Validate request.