federation

Documentation

Index

• type DeleteAllFilesRequest
  • func (r DeleteAllFilesRequest) Validate() error
• type RemoveAllFollowingRequest
  • func (r RemoveAllFollowingRequest) Validate() error
• type Service
  • func NewService(requestHandler core.RequestHandlerFunc) *Service
  • func (s *Service) DeleteAllFiles(request DeleteAllFilesRequest) error
  • func (s *Service) RemoveAllFollowing(request RemoveAllFollowingRequest) error
  • func (s *Service) UpdateInstance(request UpdateInstanceRequest) error
  • func (s *Service) UpdateRemoteUser(request UpdateRemoteUserRequest) error
• type UpdateInstanceRequest
  • func (r UpdateInstanceRequest) Validate() error
• type UpdateRemoteUserRequest
  • func (r UpdateRemoteUserRequest) Validate() error

Examples

• Service.DeleteAllFiles
• Service.RemoveAllFollowing
• Service.UpdateInstance
• Service.UpdateRemoteUser

Types

type DeleteAllFilesRequest

type DeleteAllFilesRequest struct {
	Host string `json:"host"`
}

DeleteAllFilesRequest represents a Clear request.

func (DeleteAllFilesRequest) Validate

func (r DeleteAllFilesRequest) Validate() error

Validate the request.

type RemoveAllFollowingRequest

type RemoveAllFollowingRequest struct {
	Host string `json:"host"`
}

RemoveAllFollowingRequest represents a Clear request.

func (RemoveAllFollowingRequest) Validate

func (r RemoveAllFollowingRequest) 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) DeleteAllFiles

func (s *Service) DeleteAllFiles(request DeleteAllFilesRequest) error

DeleteAllFiles logs.

Example

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

err := client.Admin().Federation().DeleteAllFiles(federation.DeleteAllFilesRequest{
	Host: "quey.org",
})
if err != nil {
	log.Printf("[Admin/Federation] %s", err)
}

func (*Service) RemoveAllFollowing

func (s *Service) RemoveAllFollowing(request RemoveAllFollowingRequest) error

RemoveAllFollowing logs.

Example

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

err := client.Admin().Federation().RemoveAllFollowing(federation.RemoveAllFollowingRequest{
	Host: "quey.org",
})
if err != nil {
	log.Printf("[Admin/Federation] %s", err)
}

func (*Service) UpdateInstance

func (s *Service) UpdateInstance(request UpdateInstanceRequest) error

UpdateInstance logs.

Example

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

err := client.Admin().Federation().UpdateInstance(federation.UpdateInstanceRequest{
	Host:        "misskey.io",
	IsSuspended: false,
})
if err != nil {
	log.Printf("[Admin/Federation] %s", err)
}

func (*Service) UpdateRemoteUser

func (s *Service) UpdateRemoteUser(request UpdateRemoteUserRequest) error

UpdateRemoteUser logs.

Example

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

err := client.Admin().Federation().UpdateRemoteUser(federation.UpdateRemoteUserRequest{
	UserID: "1111",
})
if err != nil {
	log.Printf("[Admin/Federation] %s", err)
}

type UpdateInstanceRequest

type UpdateInstanceRequest struct {
	Host        string `json:"host"`
	IsSuspended bool   `json:"isSuspended"`
}

UpdateInstanceRequest represents a Clear request.

func (UpdateInstanceRequest) Validate

func (r UpdateInstanceRequest) Validate() error

Validate the request.

type UpdateRemoteUserRequest

type UpdateRemoteUserRequest struct {
	UserID string `json:"userId"`
}

UpdateRemoteUserRequest represents a Clear request.

func (UpdateRemoteUserRequest) Validate

func (r UpdateRemoteUserRequest) Validate() error

Validate the request.