app

Documentation

Index

• Constants
• type CreateRequest
  • func (r CreateRequest) Validate() error
• type Service
  • func NewService(requestHandler core.RequestHandlerFunc) *Service
  • func (s *Service) Create(request CreateRequest) (models.App, error)
  • func (s *Service) Show(appID string) (models.App, error)
• type ShowRequest
  • func (r ShowRequest) Validate() error

Examples

• Service.Create
• Service.Show

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"`
	Description string                   `json:"description"`
	Permission  []permissions.Permission `json:"permission"`
	CallbackURL core.String              `json:"callbackUrl,omitempty"`
}

CreateRequest represents a Create request.

func (CreateRequest) Validate

func (r CreateRequest) Validate() error

Validate 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.App, error)

Create clip.

Example

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

resp, err := client.App().Create(app.CreateRequest{
	Name:        "test app",
	Description: "my test app",
	Permission: []permissions.Permission{
		permissions.Write(permissions.Account),
		permissions.Read(permissions.Account),
	},
})
if err != nil {
	log.Printf("[Apps/Create] %s", err)

	return
}

log.Printf("[Apps/Create] %s created", resp.Name)

func (*Service) Show

func (s *Service) Show(appID string) (models.App, error)

Show app.

Example

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

resp, err := client.App().Show("8y7eu4z91l")
if err != nil {
	log.Printf("[App/Show] %s", err)

	return
}

log.Printf("[App/Show] %s", resp.Name)

type ShowRequest

type ShowRequest struct {
	AppID string `json:"appId"`
}

ShowRequest represents an Show request.

func (ShowRequest) Validate

func (r ShowRequest) Validate() error

Validate the request.