notifications

Documentation

Index

• type CreateRequest
  • func (r CreateRequest) Validate() error
• type MarkAllAsReadRequest
  • func (r MarkAllAsReadRequest) Validate() error
• type Service
  • func NewService(requestHandler core.RequestHandlerFunc) *Service
  • func (s *Service) Create(request CreateRequest) error
  • func (s *Service) MarkAllAsRead() error

Examples

• Service.Create
• Service.MarkAllAsRead

Types

type CreateRequest

type CreateRequest struct {
	Body   string      `json:"body"`
	Header core.String `json:"header"`
	Icon   core.String `json:"icon"`
}

CreateRequest represents an Create request.

func (CreateRequest) Validate

func (r CreateRequest) Validate() error

Validate the request.

type MarkAllAsReadRequest

type MarkAllAsReadRequest struct{}

MarkAllAsReadRequest represents an MarkAllAsRead request.

func (MarkAllAsReadRequest) Validate

func (r MarkAllAsReadRequest) 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) error

Create endpoint.

Example

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

err := client.Notifications().Create(notifications.CreateRequest{
	Header: core.NewString("Thi is the header"),
	Body:   "Example notification",
})
if err != nil {
	log.Printf("[Notifications] Error happened: %s", err)

	return
}

func (*Service) MarkAllAsRead

func (s *Service) MarkAllAsRead() error

MarkAllAsRead endpoint.

Example

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

err := client.Notifications().MarkAllAsRead()
if err != nil {
	log.Printf("[Notifications] Error happened: %s", err)

	return
}